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>Alloc</title>
8  </head>
9  <body>
10    <h1>nw::snd::SoundHeap::Alloc Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHeap.h&gt;
14
15void * Alloc(
16     size_t size,
17     <a href="../../../nw/snd/SoundHeap/DisposeCallback.html">SoundHeap::DisposeCallback</a> callback,
18     void* callbackArg
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><CODE>size</CODE></th>
35          <td>Memory size to be allocated.</td>
36        </tr>
37        <tr>
38          <td>in</td>
39          <th>callback</th>
40          <td>The callback function to invoke when the memory block is freed.</td>
41        </tr>
42        <tr>
43          <td>in</td>
44          <th>callbackArg</th>
45          <td>User data for the argument of the callback function.</td>
46        </tr> </table>
47    </div>
48    <h2>Return Values</h2>
49    <div class="section">Returns the starting address of the allocated memory block. </div>
50    <h2>Description</h2>
51    <div class="section">
52      <p>Allocates memory from the sound heap.</p><p>A management region is needed in each memory block. As a result, you actually need slightly more free space than the memory size being allocated (<span>size</span>). The function will fail if there is not enough space.</p><p>The callback function (<a href="../../../nw/snd/SoundHeap/Clear.html">callback</a>) is invoked when memory blocks are freed by <span><span>Clear</span></span> or <span><span>LoadState</span></span>. Set the callback to NULL if it is unnecessary.</p></div>
53    <h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2009/12/28</dt>
57        <dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>