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>Initialize</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/os/Overview.html">os</a>::<a href="../../../nn/os/StackMemory/Overview.html">StackMemory</a>::Initialize</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14void Initialize(
15     void * pMem,
16     size_t size
17);
18</pre>
19    </div>
20<h2>Parameters</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>in</td>
32<th>pMem</th>
33<td>Pointer to the beginning of the memory region to partition. Must be 4096-byte aligned.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>size</th>
38<td>Size of memory region to partition. The <SPAN class="argument">size</SPAN> argument must be a multiple of <CODE>4096</CODE>.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42    <div class="section">
43None.
44               </div>
45<h2>Description</h2>
46    <div class="section">
47<p>Partitions a memory region.</p><p>The function internally calls <CODE><a href="../../../nn/os/StackMemory/TryInitialize.html">TryInitialize</a></CODE>, and if that process fails the function stops the program. (In the retail product environment, this is handled as a fatal error.)</p><p>
48This function can only partition memory allocated from the heap region. It cannot partition buffers allocated statically from the code region, and it cannot partition regions in device memory.
49            </p><p>
50To read about other causes of failure, see <CODE><a href="../../../nn/os/StackMemory/TryInitialize.html">TryInitialize</a></CODE>.
51            </p></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2011/12/19</dt>
56<dd>Noted that memory must be allocated from the heap region.<br />
57        </dd>
58        <dt>2011/06/22</dt>
59<dd>Changed the description in line with the addition of <CODE>TryInitialize</CODE>.<br />
60        </dd>
61        <dt>2010/08/18</dt>
62<dd>Initial version.<br />
63        </dd>
64      </dl>
65    </div>
66  <hr><p>CONFIDENTIAL</p></body>
67</html>
68