1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>OSDestroyHeap</title>
10</head>
11
12<body>
13
14<h1>OSDestroyHeap</h1>
15
16
17<h2>C Specification</h2>
18
19<dl>
20<dd><pre><code>#include &lt;revolution/os.h&gt;</code></pre>
21  </dd>
22<dd><pre><code>void* OSDestroyHeap (OSHeapHandle heap);</code></pre>
23  </dd>
24</dl>
25
26<h2>Arguments</h2>
27<TABLE border="1" cellpadding="3" cellspacing="0.1">
28  <tr>
29<TD width="120" bgcolor="#ffffe8"><em><strong><code><STRONG><EM><CODE>heap</CODE></EM></STRONG></code></strong></em></TD>
30<TD width="520">The operating heap handle previously created with the <a href="OSCreateHeap.html"><code>OSCreateHeap</code></a> function.</TD>
31    </tr>
32</TABLE>
33<h2>Return Values</h2>
34
35<p>None.</p>
36<H2>Description</H2>
37<P>Although this function is provided for compatibility's sake, we recommend using the MEM library.  </P>
38<P>Frees the descriptor for the heap region <code><strong><em>heap</em></strong></code>. Subsequent allocation requests from this heap will fail unless another heap with the same handle is created.</P>
39
40
41
42<h2>See Also</h2>
43
44<p><a href="../list.html#Memory Allocation" target="contents">Memory Allocation Functions</a>, <a href="OSCreateHeap.html"><code>OSCreateHeap</code></a></p>
45<H2>Revision History</H2>
46<P>03/01/2006 Initial version.</P>
47</body>
48</html>