Symbian3/PDK/Source/GUID-AECDAEBF-777A-579B-92F8-560FD7FF86E7.dita
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Fri, 22 Jan 2010 18:26:19 +0000
changeset 1 25a17d01db0c
child 3 46218c8b8afa
permissions -rw-r--r--
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608

<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
<!-- Initial Contributors:
    Nokia Corporation - initial contribution.
Contributors: 
-->
<!DOCTYPE concept
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="GUID-AECDAEBF-777A-579B-92F8-560FD7FF86E7" xml:lang="en"><title>NAME
statement</title><prolog><metadata><keywords/></metadata></prolog><conbody>
<codeblock xml:space="preserve">&lt;name-statement&gt;
name-statement ::= 
NAME &lt;short-name&gt;</codeblock>
<p>Use this statement to ensure that the resources in the file have a unique
ID so that an application can use multiple resource files without resource
ID conflict.</p>
<p>This statement must be the first non-comment statement in the file.</p>
<p>The <varname>short-name</varname> must be between one and four alphabetic
characters long and be unique (no other file may use the same one). For the
sake of consistency this constant should be in upper case although lower case
is allowed (and will be converted to upper case by the compiler). This <varname>short-name</varname> is
then converted into a number and shifted onto the leading 20 bits of the resource
ID, leaving the bottom 12 bits for the number of the resource in the file.
This allows a maximum of 4095 resources to be defined in a source file.</p>
<p>Since the <codeph>NAME</codeph> statement maps all resource IDs within
the file onto 32-bit numbers, only <codeph>LLINK</codeph> s may be used for
resource references in that file. Using the <codeph>NAME</codeph> statement
in a resource file means that any attempt to use a <codeph>LINK</codeph> will
generate an error.</p>
<example><p>With <codeph>NAME</codeph> set to <codeph>AAAA</codeph>,
if this resource is the first resource in the file</p><codeblock id="GUID-42436ADC-996A-5D24-BC6B-8072DF8F271F" xml:space="preserve">RESOURCE STRING one
 {
 wd=5;
 }</codeblock><p>the first entry in the generated header file will be</p><codeblock id="GUID-707F02E8-CD7D-54BB-B11D-FB3B46876DF5" xml:space="preserve">#define ONE 0x04FD8001</codeblock><p>04FD8
is the leading 20 bits for all IDs in the file and 001 is the reference of
that resource within the file.</p></example>
</conbody></concept>