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<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/os.h&gt;
19
20void* OSDestroyHeap(OSHeapHandle heap);
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<TH><STRONG><EM><CODE>heap</CODE></EM></STRONG></TH>
27<TD>Handle to an active heap, previously created with the <A href="OSCreateHeap.html"><CODE>OSCreateHeap</CODE></A> function</TD>
28  </tr>
29</TABLE>
30
31<h2>Return Values</h2>
32<p>None.</p>
33
34<H2>Description</H2>
35<P>Although this function is provided for the sake of compatibility, we recommend using the MEM library.</P>
36<P>Deallocates the descriptor for the heap region <SPAN class="argument">heap</SPAN>. Subsequent allocation requests from this heap will fail unless another heap with the same handle is created.</P>
37
38<h2>See Also</h2>
39<P class="reference">
40<a href="../toc.html#Memory Allocation" target="contents">Memory Allocation Functions</a>,
41<a href="OSCreateHeap.html">OSCreateHeap</a>
42</p>
43
44<H2>Revision History</H2>
45<P>
462006/03/01 Initial version.<br>
47</P>
48
49<hr><p>CONFIDENTIAL</p></body>
50</html>