Symbian3/SDK/Source/GUID-C99BA704-4E9F-482C-942F-1B4D7F385BD8.dita
changeset 0 89d6a7a84779
equal deleted inserted replaced
-1:000000000000 0:89d6a7a84779
       
     1 <?xml version="1.0" encoding="utf-8"?>
       
     2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
       
     3 <!-- This component and the accompanying materials are made available under the terms of the License 
       
     4 "Eclipse Public License v1.0" which accompanies this distribution, 
       
     5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
       
     6 <!-- Initial Contributors:
       
     7     Nokia Corporation - initial contribution.
       
     8 Contributors: 
       
     9 -->
       
    10 <!DOCTYPE concept
       
    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
       
    12 <concept id="GUID-C99BA704-4E9F-482C-942F-1B4D7F385BD8" xml:lang="en"><title>HelloWorldBasic_reg.rss</title><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    13 <p>You need to register your applications in order to make them visible
       
    14 to the application launcher and to provide other information to the underlying
       
    15 system. To register, you need to provide a registration resource file, typically
       
    16 named <parmname>&lt;application_name&gt;_reg.rss</parmname>, that contains the
       
    17 non-localized information for your application. This section contains an example
       
    18 of such a file.</p>
       
    19 <p>For more information on registration files in general, see <xref href="GUID-FE9017F4-4197-472F-A3E7-267169A51ABD.dita">Registration</xref>. </p>
       
    20 <p>For information on creating your own registration resource files, see <xref href="GUID-BF1AAA0D-DF2F-4E1D-A0D2-F419BD32F97A.dita">Creating
       
    21 registration resource files</xref>.</p>
       
    22 <codeblock id="GUID-631DE04B-6396-4CAD-B428-3342D06BA732" xml:space="preserve">#include "Helloworldbasic.rls"
       
    23 </codeblock>
       
    24 <p>This preprocessor statement adds the <parmname>rls</parmname> project
       
    25 file that controls the strings loaded for different languages based on the
       
    26 Symbian OS language setting to the preprocessing path. For more information
       
    27 on localisation, see <xref href="GUID-E111C4E8-1342-4E87-ACB4-5B630AF1501C.dita">Internationalization
       
    28 and localization</xref>.</p>
       
    29 <codeblock id="GUID-1081D8D5-FE34-4A9F-B335-32E9A809314F" xml:space="preserve">#include  &lt;appinfo.rh&gt;
       
    30 </codeblock>
       
    31 <p>This preprocessor statement adds the resource header file that provides
       
    32 the data structure used for the <parmname>RESOURCE</parmname> statement in
       
    33 this registration resource file.</p>
       
    34 <codeblock id="GUID-C78D64EE-3ED7-4A8A-96C6-C048879F35C2" xml:space="preserve">#include  &lt;HelloWorldBasic.rsg&gt;
       
    35 
       
    36 </codeblock>
       
    37 <p>This preprocessor statement adds the generated resource header file
       
    38 for the <i>HelloWorldBasic</i> application to the preprocessor path to allow
       
    39 access to the <parmname>R_HELLOWORLDBASIC_LOCALISABLE_APP_INFO</parmname> resource.</p>
       
    40 <codeblock id="GUID-6921E324-DF9E-4646-9ED9-8139F1A7816A" xml:space="preserve">UID2 KUidAppRegistrationResourceFile
       
    41 </codeblock>
       
    42 <p>This required statement defines the UID2 value for a registration resource
       
    43 file. </p>
       
    44 <codeblock id="GUID-C3F02E64-0C14-4A31-BBC2-772021D3E833" xml:space="preserve">UID3 0xA000017F
       
    45 
       
    46 </codeblock>
       
    47 <p>This required statement defines the <xref href="GUID-EA05F9B6-52C7-4BD9-8B9A-4BA3456E70B5.dita">UID3</xref> of
       
    48 the application.</p>
       
    49 <codeblock id="GUID-CCFD588A-30DC-43ED-9AB1-AB2AC3A83079" xml:space="preserve">RESOURCE APP_REGISTRATION_INFO
       
    50   {
       
    51   app_file="HelloWorldBasic";
       
    52   localisable_resource_file =  STRING_r_helloworldbasic_loc_resource_file_1;
       
    53   localisable_resource_id = R_HELLOWORLDBASIC_LOCALISABLE_APP_INFO;
       
    54 
       
    55   embeddability=KAppNotEmbeddable;
       
    56   newfile=KAppDoesNotSupportNewFile;
       
    57   }
       
    58 
       
    59 </codeblock>
       
    60 <p>This <parmname>RESOURCE</parmname> definition contains the nonlocalizable
       
    61 properties of the <i>HelloWorldBasic</i> application, where</p>
       
    62 <ul>
       
    63 <li><p><parmname>HelloWorldBasic</parmname> is the name of the application
       
    64 executable</p></li>
       
    65 <li><p><parmname>STRING_r_helloworldbasic_loc_resource_file_1</parmname> contains
       
    66 the value <parmname>\\resource\\apps\\HelloWorldBasic</parmname> in all <parmname>rls</parmname> files.
       
    67 This is the location of the <i>HelloWorldBasic</i> resource files.</p>
       
    68 </li>
       
    69 <li><p><parmname>R_HELLOWORLDBASIC_LOCALISABLE_APP_INFO</parmname> is
       
    70 the identifier for the resource declared in <parmname>helloworldbasic.rss</parmname> that
       
    71 contains the short caption, caption, and icon information</p></li>
       
    72 <li><p><parmname>KAppNotEmbeddable</parmname> indicates that <i>HelloWorldBasic</i> is
       
    73 not embeddable</p></li>
       
    74 <li><p><parmname>KAppDoesNotSupportNewFile</parmname> indicates
       
    75 that <i>HelloWorldBasic</i> does not support new files</p></li>
       
    76 </ul>
       
    77 </conbody></concept>