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>SaveState</title>
8  </head>
9  <body>
10    <h1>nw::snd::SoundHeap::SaveState Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHeap.h&gt;
14
15int SaveState();
16</pre>
17    </div>
18    <h2>Arguments</h2>
19    <div class="section">
20      <p>None.</p>
21    </div>
22    <h2>Return Values</h2>
23    <div class="section">Returns the hierarchical level <i>after</i> the state save. Returns -1 if the state save fails. </div>
24    <h2>Description</h2>
25    <div class="section">
26      <p>Saves the current state of the sound heap.</p><p>The hierarchical level immediately after heap creation is 0. The hierarchical level increases by 1 each time this function is called. By calling <span><span>LoadState</span></span>, you can restore the state immediately after the specified level was saved.</p><p>Saving the state will consume a small amount of the heap. If there is not enough free space in the heap, the function call fails.</p></div>
27    <h2>Revision History</h2>
28    <div class="section">
29      <dl class="history">
30        <dt>2009/12/28</dt>
31        <dd>Initial version.<br />
32        </dd>
33      </dl>
34    </div>
35  <hr><p>CONFIDENTIAL</p></body>
36</html>