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>OSFreeToHeap</title>
10</head>
11
12<body>
13
14<h1>OSFreeToHeap</h1>
15
16<h2>C Specification</h2>
17
18<dl>
19<dd><pre><code>#include &lt;revolution/os.h&gt;</code></pre>
20  </dd>
21<dd><pre><code>void OSFreeToHeap (OSHeapHandle heap, void* ptr);</code></pre>
22  </dd>
23</dl>
24
25<h2>Arguments</h2>
26<TABLE border="1" cellpadding="3" cellspacing="0.1">
27  <tr>
28<TD width="120" bgcolor="#ffffe8"><em><strong><code><STRONG><EM><CODE>heap</CODE></EM></STRONG></code></strong></em></TD>
29<TD width="520">Heap handle where <code><strong><em>ptr</em></strong></code> was allocated.</TD>
30    </tr>
31  <tr>
32<TD width="120" bgcolor="#ffffe8"><em><strong><code><code><EM><STRONG>ptr</STRONG></EM></code></code></strong></em></TD>
33<TD width="520">Pointer to object that the <a href="OSAlloc.html"><code>OSAlloc</code></a> or <a href="OSAllocFromHeap.html"><code>OSAllocFromHeap</code></a> function previously returned.</TD>
34    </tr>
35</TABLE>
36<h2>Return Values</h2>
37
38<p>None.</p>
39<H2>Description</H2>
40<P>Although this function is provided for compatibility's sake, we recommend using the MEM library.  </P>
41<P>Returns memory region referenced by <code><strong><em>ptr</em></strong></code> to <code><strong><em>heap</em></strong></code>.</P>
42
43
44
45<h2>See Also</h2>
46
47<p><a href="../list.html#Memory Allocation" target="contents">Memory Allocation Functions</a>, <a href="OSAlloc.html"><code>OSAlloc</code></a>, <a href="OSAllocFromHeap.html"><code>OSAllocFromHeap</code></a>, <a href="OSSetCurrentHeap.html"><code>OSSetCurrentHeap</code></a></p>
48<H2>Revision History</H2>
49<P>03/01/2006 Initial version.</P>
50</body>
51</html>