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>nw::snd::SoundDataManager::LoadData</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundDataManager.h&gt;
14
15bool LoadData(
16     <a href="../../../nw/snd/SoundArchive/ItemId.html">SoundArchive::ItemId</a> id,
17     <a href="../../../nw/snd/SoundMemoryAllocatable/Overview.html">SoundMemoryAllocatable</a> * pAllocator,
18     <span>u32</span> loadFlag = LOAD_ALL,
19     size_t loadBlockSize = 0
20);
21</pre>
22    </div>
23    <h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29            <th>Name</th>
30            <td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34          <td>in</td>
35          <th>id</th>
36          <td>Item ID of the data to load.</td>
37        </tr>
38        <tr>
39          <td>in</td>
40          <th>pAllocator</th>
41          <td>Allocator that allocates memory for loading data.</td>
42        </tr>
43        <tr>
44          <td>in</td>
45          <th>loadFlag</th>
46          <td>Flag used to load related data.</td>
47        </tr>
48        <tr>
49          <td>in</td>
50          <th>loadBlockSize</th>
51          <td>Block size (in bytes) when data is loaded in blocks.</td>
52        </tr> </table>
53    </div>
54    <h2>Return Values</h2>
55    <div class="section">Returns <span>true</span> if data was loaded successfully and <span>false</span> otherwise. </div>
56    <h2>Description</h2>
57    <div class="section">
58      <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></div>
59    <h2>See Also</h2>
60    <div class="section">
61      <p class="reference"><a href="../../../nw/snd/SoundDataManager/Initialize.html"><CODE>Initialize</CODE></a><br /><a href="../../../nw/snd/SoundDataManager/IsAvailable.html"><CODE>IsAvailable</CODE></a><br /> </p>
62    </div>
63    <h2>Revision History</h2>
64    <div class="section">
65      <dl class="history">
66        <dt>2010/09/06</dt>
67        <dd>Adjusted argument names in line with support for specifying loadBlockSize.<BR>
68        </dd>
69        <dt>2010/04/09</dt>
70        <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 />
71        </dd>
72        <dt>2010/01/15</dt>
73        <dd>Initial version.<br />
74        </dd>
75      </dl>
76    </div>
77  <hr><p>CONFIDENTIAL</p></body>
78</html>