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>nw::snd::RomSoundArchive::LoadLabelStringData Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_RomSoundArchive.h&gt;
14
15bool LoadLabelStringData(
16     void         *buffer,
17     unsigned long size
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td>out</td>
33          <th>buffer</th>
34          <td>Pointer to the buffer used to load label strings.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th><CODE>size</CODE></th>
39          <td>The buffer size.</td>
40        </tr> </table>
41    </div>
42    <h2>Return Values</h2>
43    <div class="section">Returns <span>true</span> if the label string loaded successfully and <span>false</span> otherwise. </div>
44    <h2>Description</h2>
45    <div class="section">
46      <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 <span><span>GetLabelStringDataSize</span></span> 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>
47    <h2>See Also</h2>
48    <div class="section">
49      <p class="reference"><a href="../../../nw/snd/RomSoundArchive/Open.html"><CODE>Open</CODE></a><br /> </p>
50    </div>
51    <h2>Revision History</h2>
52    <div class="section">
53      <dl class="history">
54        <dt>2010/06/25</dt>
55        <dd>Added information about the sound archive string table.<br />
56        </dd>
57        <dt>2010/01/15</dt>
58        <dd>Initial version.<br />
59        </dd>
60      </dl>
61    </div>
62  <hr><p>CONFIDENTIAL</p></body>
63</html>