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>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/os.h&gt;
19
20void OSFreeToHeap(OSHeapHandle heap, void* ptr);
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 the heap from which <SPAN class="argument">ptr</SPAN> was allocated</TD>
28  </tr>
29  <tr>
30<TH>ptr</TH>
31<TD>Pointer to the object previously returned from the <A href="OSAlloc.html"><CODE>OSAlloc</CODE></A> or <A href="OSAllocFromHeap.html"><CODE>OSAllocFromHeap</CODE></A> function</TD>
32  </tr>
33</TABLE>
34
35<h2>Return Values</h2>
36<p>None.</p>
37
38<H2>Description</H2>
39<P>Although this function is provided for the sake of compatibility, we recommend using the MEM library.</P>
40<P>Returns the memory region referred to by <SPAN class="argument">ptr</SPAN> in <SPAN class="argument">heap</SPAN>.</P>
41
42<h2>See Also</h2>
43<P class="reference">
44<a href="../toc.html#Memory Allocation" target="contents">Memory Allocation Functions</a>,
45<a href="OSAlloc.html">OSAlloc</a>,
46<a href="OSAllocFromHeap.html">OSAllocFromHeap</a>,
47<a href="OSSetCurrentHeap.html">OSSetCurrentHeap</a>
48</p>
49
50<H2>Revision History</H2>
51<P>
522006/03/01 Initial version.<br>
53</P>
54
55<hr><p>CONFIDENTIAL</p></body>
56</html>