1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <title>GetItemLabel</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::<a href="../../../nw/snd/SoundArchive/Overview.html">SoundArchive</a>::GetItemLabel</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundArchive.h&gt;
14const char * GetItemLabel(
15     <a href="../../../nw/snd/SoundArchive/ItemId.html">ItemId</a> id
16) const;
17</pre>
18    </div>
19    <h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25            <th>Name</th>
26            <td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30          <td>in</td>
31          <th>id</th>
32          <td>Item ID in the sound archive.</td>
33        </tr> </table>
34    </div>
35    <h2>Return Values</h2>
36    <div class="section">Returns the label string that corresponds to the specified ID. </div>
37    <h2>Description</h2>
38    <div class="section">
39      <p>Gets the label string that corresponds to an item ID.</p><p>NULL is returned if the specified item ID does not exist.</p><p>Regardless of <a href="../../../nw/snd/MemorySoundArchive/Overview.html">MemorySoundArchive</a> and <a href="../../../nw/snd/RomSoundArchive/Overview.html">RomSoundArchive</a>, a string table must be included in the sound archive file to use string information.</p><p>To include string information in a sound archive file, from the SoundMaker <B>Projects</B> menu select <B>Project Settings</B>, and then on the <B>Sound Archive</B> tab, select the &quot;Ouput the string table&quot; checkbox.</p><p>When using <a href="../../../nw/snd/RomSoundArchive/Overview.html">RomSoundArchive</a>, label string data must be already loaded using <a href="../../../nw/snd/RomSoundArchive/LoadLabelStringData.html">RomSoundArchive::LoadLabelStringData</a>. NULL is returned if string data is not loaded.</p><p>NULL is returned if <a href="../../../nw/snd/MemorySoundArchive/Overview.html">MemorySoundArchive</a> does not include a string table.</p></div>
40    <h2>See Also</h2>
41    <div class="section">
42      <p class="reference"><a href="../../../nw/snd/SoundArchive/ItemId.html">ItemId</a><br /><a href="../../../nw/snd/SoundArchive/GetItemId.html">GetItemId</a><br /><a href="../../../nw/snd/RomSoundArchive/LoadLabelStringData.html">RomSoundArchive::LoadLabelStringData</a><br /> </p>
43    </div>
44    <h2>Revision History</h2>
45    <div class="section">
46      <dl class="history">
47        <dt>2010/09/21</dt>
48        <dd>Added the fact that null is returned if the ID does not exit or a label string is not included.<BR>
49        </dd>
50        <dt>2010/06/25</dt>
51        <dd>Added information about the sound archive string table.<br />
52        </dd>
53        <dt>2010/01/15</dt>
54        <dd>Initial version.<br />
55        </dd>
56      </dl>
57    </div>
58  <hr><p>CONFIDENTIAL</p></body>
59</html>
60