9 --> |
9 --> |
10 <!DOCTYPE concept |
10 <!DOCTYPE concept |
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
12 <concept id="GUID-BF1AAA0D-DF2F-4E1D-A0D2-F419BD32F97A" xml:lang="en"><title>Creating |
12 <concept id="GUID-BF1AAA0D-DF2F-4E1D-A0D2-F419BD32F97A" xml:lang="en"><title>Creating |
13 registration resource files</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 registration resource files</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
14 <p>You need to register your applications in order to make them visible |
14 <p>You need to register your applications |
15 to the application menu and to provide other information to the underlying |
15 in order to make them visible to the application menu and to provide other |
16 system. To register, you need to provide a registration resource file, typically |
16 information to the underlying system. To register, you need to provide a registration |
17 named <parmname><application_name>_reg.rss</parmname>, that contains the |
17 resource file, typically named <parmname><application_name>_reg.rss</parmname>, |
18 non-localized information for your application. You also need to provide the <xref href="GUID-9F90A2F0-9C76-4871-A766-D1AE0FC42C08.dita">localizable registration |
18 that contains the non-localized information for your application. You also |
19 information</xref>. The registration resource file is compiled during the |
19 need to provide the <xref href="GUID-9F90A2F0-9C76-4871-A766-D1AE0FC42C08.dita">localizable |
20 build process and included in the <xref href="GUID-7F1B2577-2FEF-45F9-B32F-745DFE0F0D95.dita"><parmname>pkg</parmname></xref> file |
20 registration information</xref>. The registration resource file is compiled |
21 used to make the <parmname>sis</parmname> <xref href="GUID-61EE2BE0-7B86-42CD-A03F-857DD8FAC246.dita">installation |
21 during the build process and included in the <parmname>pkg</parmname> file |
22 file</xref>.</p> |
22 used to make the <parmname>sis</parmname> installation file.</p> |
|
23 |
|
24 |
23 <p>To create a registration resource file:</p> |
25 <p>To create a registration resource file:</p> |
24 <ol> |
26 <ol> |
25 <li id="GUID-D97F1C74-A29A-4EF1-92C1-8FBAF2EE6F2F"><p>Determine |
27 <li id="GUID-D97F1C74-A29A-4EF1-92C1-8FBAF2EE6F2F"><p>Determine |
26 the requirements of your application.</p></li> |
28 the requirements of your application.</p></li> |
27 <li id="GUID-41830892-AA07-44F7-BCEE-4FACD88932FF"><p>Create a text |
29 <li id="GUID-41830892-AA07-44F7-BCEE-4FACD88932FF"><p>Create a text |
31 appropriate header files. Typically, you need to include the following files:</p> |
33 appropriate header files. Typically, you need to include the following files:</p> |
32 <itemgroup> |
34 <itemgroup> |
33 <ul> |
35 <ul> |
34 <li><p><parmname>appinfo.rh</parmname>, which is the resource header |
36 <li><p><parmname>appinfo.rh</parmname>, which is the resource header |
35 file that includes the data structure declaration for the resource statement |
37 file that includes the data structure declaration for the resource statement |
36 used in the registration resource file</p></li> |
38 used in the registration resource file.</p></li> |
37 <li><p>compiled resource header file for the resource file with |
39 <li><p>compiled resource header file for the resource file with |
38 the symbolic ID for the<xref href="GUID-9F90A2F0-9C76-4871-A766-D1AE0FC42C08.dita"> localizable |
40 the symbolic ID for the<xref href="GUID-9F90A2F0-9C76-4871-A766-D1AE0FC42C08.dita"> localizable |
39 registration information</xref></p></li> |
41 registration information</xref>.</p></li> |
40 <li><p>localization file, depending on you implementation of the |
42 <li><p>localization file, depending on you implementation of the |
41 registration resource file</p></li> |
43 registration resource file.</p></li> |
42 </ul> |
44 </ul> |
43 <p>For more information on pre-processor statement syntax, see <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/ToolsAndUtilities94/DevTools-ref/ResourceFileFormat/Tool_Ref_RSS-file-format.preprocess.html#DevTools%2dref%2erss%2e3" format="application/java-archive">C++ pre-processor statements</xref>.</p> |
45 <p>For more information on pre-processor statement syntax, see <xref href="jar:GUID-35228542-8C95-4849-A73F-2B4F082F0C44.jar!/sdk/doc_source/ToolsAndUtilities94/DevTools-ref/ResourceFileFormat/Tool_Ref_RSS-file-format.preprocess.html#DevTools%2dref%2erss%2e3" format="application/java-archive">C++ pre-processor statements</xref>.</p> |
44 </itemgroup> |
46 </itemgroup> |
45 </li> |
47 </li> |
46 <li id="GUID-42A15A31-6A2C-4937-9615-A128068E2F76"><p>Add a statement |
48 <li id="GUID-42A15A31-6A2C-4937-9615-A128068E2F76"><p>Add a statement |
47 for the UID2 value for the registration resource file as follows:.</p> |
49 for the UID2 value for the registration resource file as follows:</p> |
48 <itemgroup> |
50 <itemgroup> |
49 <codeblock id="GUID-A82F0146-5B48-48C8-A5F5-F200D08A6C4D" xml:space="preserve">UID2 KUidAppRegistrationResourceFile</codeblock> |
51 <codeblock id="GUID-A82F0146-5B48-48C8-A5F5-F200D08A6C4D" xml:space="preserve">UID2 KUidAppRegistrationResourceFile</codeblock> |
50 <p>UID2 always has the same value in registration resource files.</p> |
52 <p>UID2 always has the same value in registration resource files.</p> |
51 </itemgroup> |
53 </itemgroup> |
52 </li> |
54 </li> |
53 <li id="GUID-4C96D57D-FBA2-4BF6-A1AF-715467663A27"><p>Add a statement |
55 <li id="GUID-4C96D57D-FBA2-4BF6-A1AF-715467663A27"><p>Add a statement |
54 for the <xref href="GUID-EA05F9B6-52C7-4BD9-8B9A-4BA3456E70B5.dita">UID3</xref> value |
56 for the <xref href="GUID-EA05F9B6-52C7-4BD9-8B9A-4BA3456E70B5.dita">UID3</xref> value |
55 of the application as follows</p> |
57 of the application as follows:</p> |
56 <itemgroup> |
58 <itemgroup> |
57 <codeblock id="GUID-EA7F044D-2BB2-4552-B768-3248DF6DAF7F" xml:space="preserve">UID3 <uid3 value for application></codeblock> |
59 <codeblock id="GUID-EA7F044D-2BB2-4552-B768-3248DF6DAF7F" xml:space="preserve">UID3 <uid3 value for application></codeblock> |
58 </itemgroup> |
60 </itemgroup> |
59 </li> |
61 </li> |
60 <li id="GUID-6A8002EA-AFF5-4750-833C-81ED5F355C6C"><p>Create a <parmname>APP_REGISTRATION_INFO</parmname> resource |
62 <li id="GUID-6A8002EA-AFF5-4750-833C-81ED5F355C6C"><p>Create a <parmname>APP_REGISTRATION_INFO</parmname> resource |
61 for your application. The definition for the registration code block is as |
63 for your application. The definition for the registration code block is as |
62 follows:</p> |
64 follows:</p> |
63 <itemgroup> |
65 <itemgroup> |
64 <codeblock id="GUID-EF44E298-635E-40BD-8FBE-8A6712FCA0FB" xml:space="preserve"> |
66 <codeblock id="GUID-EF44E298-635E-40BD-8FBE-8A6712FCA0FB" xml:space="preserve"> |
65 RESOURCE APP_REGISTRATION_INFO |
67 RESOURCE APP_REGISTRATION_INFO |
66 { |
68 { |
67 app_file = ""; // name of application binary file (not including extension) - mandatory |
69 app_file = ""; // name of application binary file (not including extension) - mandatory |
68 attributes = 0; |
70 attributes = 0; |
69 localisable_resource_file = ""; // path (not including drive) and name of localisable resource file |
71 localisable_resource_file = ""; // path (not including drive) and name of localisable resource file |
70 localisable_resource_id = r_name36; |
72 localisable_resource_id = r_name36; |
71 hidden = KAppNotHidden; |
73 hidden = KAppNotHidden; |
72 embeddability = KAppNotEmbeddable; |
74 embeddability = KAppNotEmbeddable; |
73 newfile = KAppDoesNotSupportNewFile; |
75 newfile = KAppDoesNotSupportNewFile; |
74 launch = KAppLaunchInForeground; |
76 launch = KAppLaunchInForeground; |
75 group_name(KAppMaxGroupName) = ""; |
77 group_name(KAppMaxGroupName) = ""; |
76 default_screen_number = 0; |
78 default_screen_number = 0; |
77 datatype_list[]; // SUPPORTED DATATYPES |
79 datatype_list[]; // SUPPORTED DATATYPES |
78 file_ownership_list[]; // FILE_OWNERSHIP_INFO |
80 file_ownership_list[]; // FILE_OWNERSHIP_INFO |
79 service_list[]; // SERVICE_INFO |
81 service_list[]; // SERVICE_INFO |
80 opaque_data = 0; // use for opaque data to send to non-native application launchers i.e. MIDlet id |
82 opaque_data = 0; // use for opaque data to send to non-native application launchers i.e. MIDlet id |
81 }</codeblock> |
83 }</codeblock> |
82 <p>where,</p> |
84 <p>where,</p> |
83 <ul> |
85 <ul> |
84 <li><p><parmname>app_file</parmname> indicates the name of the application |
86 <li><p><parmname>app_file</parmname> indicates the name of the application |
85 executable binary file without the extension</p></li> |
87 executable binary file without the extension.</p></li> |
86 <li><p><parmname>localisable_resource_file</parmname> indicates |
88 <li><p><parmname>localisable_resource_file</parmname> indicates |
87 the path and name of the localizable resource file for the application</p> |
89 the path and name of the localizable resource file for the application.</p> |
88 </li> |
90 </li> |
89 <li><p><parmname>localisable_resource_id</parmname> indicates the |
91 <li><p><parmname>localisable_resource_id</parmname> indicates the |
90 symbolic name of the resource for the <xref href="GUID-9F90A2F0-9C76-4871-A766-D1AE0FC42C08.dita">localizable |
92 symbolic name of the resource for the <xref href="GUID-9F90A2F0-9C76-4871-A766-D1AE0FC42C08.dita">localizable |
91 registration resource</xref></p></li> |
93 registration resource</xref>.</p></li> |
92 <li><p><parmname>newfile</parmname> indicates whether the application |
94 <li><p><parmname>newfile</parmname> indicates whether the application |
93 is document-based and supports the creation of new files. The default value |
95 is document-based and supports the creation of new files. The default value |
94 is <parmname>KAppDoesNotSupportNewFile</parmname>.</p></li> |
96 is <parmname>KAppDoesNotSupportNewFile</parmname>.</p></li> |
95 <li><p><parmname>embeddability</parmname> indicates whether an application |
97 <li><p><parmname>embeddability</parmname> indicates whether an application |
96 is embeddable.</p> |
98 is embeddable.</p> |