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><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::<a href="../../../nw/snd/SoundHeap/Overview.html">SoundHeap</a>::SaveState</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHeap.h&gt;
14int SaveState();
15</pre>
16    </div>
17    <h2>Arguments</h2>
18    <div class="section">
19      <p>None.</p>
20    </div>
21    <h2>Return Values</h2>
22    <div class="section">Returns the hierarchical level <i>after</i> the state save. Returns -1 if the state save fails. </div>
23    <h2>Description</h2>
24    <div class="section">
25      <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>
26    <h2>Revision History</h2>
27    <div class="section">
28      <dl class="history">
29        <dt>2009/12/28</dt>
30        <dd>Initial version.<br />
31        </dd>
32      </dl>
33    </div>
34  <hr><p>CONFIDENTIAL</p></body>
35</html>
36