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>nw::snd::SoundArchive::GetItemLabel Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundArchive.h&gt;
14
15const char * GetItemLabel(
16     <a href="../../../nw/snd/SoundArchive/ItemId.html">ItemId</a> id
17) const;
18</pre>
19    </div>
20    <h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>in</td>
32          <th>id</th>
33          <td>Item ID in the sound archive.</td>
34        </tr> </table>
35    </div>
36    <h2>Return Values</h2>
37    <div class="section">Returns the label string that corresponds to the specified ID. </div>
38    <h2>Description</h2>
39    <div class="section">
40      <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>
41    <h2>See Also</h2>
42    <div class="section">
43      <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>
44    </div>
45    <h2>Revision History</h2>
46    <div class="section">
47      <dl class="history">
48        <dt>2010/09/21</dt>
49        <dd>Added the fact that null is returned if the ID does not exit or a label string is not included.<BR>
50        </dd>
51        <dt>2010/06/25</dt>
52        <dd>Added information about the sound archive string table.<br />
53        </dd>
54        <dt>2010/01/15</dt>
55        <dd>Initial version.<br />
56        </dd>
57      </dl>
58    </div>
59  <hr><p>CONFIDENTIAL</p></body>
60</html>