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>LoadData</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/SoundDataManager/Overview.html">SoundDataManager</a>::LoadData</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool LoadData(
15     const char * pItemName,
16     <a href="../../../nw/snd/SoundMemoryAllocatable/Overview.html">SoundMemoryAllocatable</a> * pAllocator,
17     <span>u32</span> loadFlag = LOAD_ALL,
18     size_t loadBlockSize = 0
19);
20</pre>
21    </div>
22    <h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28            <th>Name</th>
29            <td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33          <td>in</td>
34          <th>pItemName</th>
35          <td>Label string for the data to load.</td>
36        </tr>
37        <tr>
38          <td>in</td>
39          <th>pAllocator</th>
40          <td>Allocator that allocates memory for loading data.</td>
41        </tr>
42        <tr>
43          <td>in</td>
44          <th>loadFlag</th>
45          <td>Flag used to load related data.</td>
46        </tr>
47        <tr>
48          <td>in</td>
49          <th>loadBlockSize</th>
50          <td>Block size (in bytes) when data is loaded in blocks.</td>
51        </tr> </table>
52    </div>
53    <h2>Return Values</h2>
54    <div class="section">Returns <span>true</span> if data was loaded successfully and <span>false</span> otherwise. </div>
55    <h2>Description</h2>
56    <div class="section">
57      <p>Loads the data in a sound archive.</p><p>The memory required to load data is allocated by pAllocater. Returns FALSE if sufficient memory cannot be allocated.</p><p>This function synchronously loads sound data. When loading sound data asynchronously, call this function from a thread used for loading. This function is thread-safe as long as no operations are performed while loading on the associated sound archive or on the sound heap passed as an argument.</p>
58      </div>
59    <h2>See Also</h2>
60    <div class="section">
61      <p class="reference"><a href="../../../nw/snd/SoundDataManager/IsDataLoaded.html"><CODE>IsDataLoaded</CODE></a><br /> </p>
62    </div>
63    <h2>Revision History</h2>
64    <div class="section">
65      <dl class="history">
66        <dt>2010/12/17</dt>
67        <dd>Removed <CODE>Initialize</CODE> and <CODE>IsAvailable</CODE> from <B>See Also</B>.<br />
68        </dd>
69        <dt>2010/09/06</dt>
70        <dd>Adjusted argument names in line with support for specifying loadBlockSize.<BR>
71        </dd>
72        <dt>2010/04/09</dt>
73        <dd>Made minor revisions to the wording (changed &quot;group&quot; to &quot;sound data&quot;), and added <CODE>IsDataLoaded</CODE> to <B>See Also</B>.<br />
74        </dd>
75        <dt>2010/01/15</dt>
76        <dd>Initial version.<br />
77        </dd>
78      </dl>
79    </div>
80  <hr><p>CONFIDENTIAL</p></body>
81</html>