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>LoadLabelStringData</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/HioSoundArchive/Overview.html">HioSoundArchive</a>::LoadLabelStringData</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_HioSoundArchive.h&gt;
14bool LoadLabelStringData(
15     void         *buffer,
16     size_t size
17);
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>out</td>
32          <th>buffer</th>
33          <td>Pointer to the buffer used to load label strings.</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th><CODE>size</CODE></th>
38          <td>The buffer size.</td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">Returns <span>true</span> if the label string loaded successfully and <span>false</span> otherwise. </div>
43    <h2>Description</h2>
44    <div class="section">
45      <p>Loads the label string data in the sound archive.</p><p>Label string data must be loaded beforehand to access resources included in the sound archive by their label strings.</p><p>You can use <a href="../../../nw/snd/HioSoundArchive/GetLabelStringDataSize.html"><CODE>GetLabelStringDataSize</CODE></a> to get the amount of memory required to load the label string data.</p><p>Fails if the sound archive file (.bcsar) does not include a string table. If this happens, confirm under SoundMaker that the [Project Settings]<itemizedlist><listitem><para>[Sound Archive] tab - [Output the string table] checkbox has been selected. </para></listitem></itemizedlist></p></div>
46    <h2>See Also</h2>
47    <div class="section">
48      <p class="reference"><a href="../../../nw/snd/HioSoundArchive/Open.html"><CODE>Open</CODE></a><br /> </p>
49    </div>
50    <h2>Revision History</h2>
51    <div class="section">
52      <dl class="history">
53        <dt>2010/11/12</dt>
54        <dd>Initial version.<br />
55        </dd>
56      </dl>
57    </div>
58  <hr><p>CONFIDENTIAL</p></body>
59</html>
60