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 http-equiv="Content-Style-Type" content="text/css">
7<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
8
9<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
10
11	<TITLE>MEMFreeToFrmHeap</TITLE>
12
13</HEAD>
14
15
16<BODY>
17
18
19<H1>MEMFreeToFrmHeap</H1>
20
21<H2>Syntax</H2>
22<DL><DD><PRE class="construction">
23#include &lt;revolution/mem.h&gt;
24
25void MEMFreeToFrmHeap( MEMHeapHandle heap, int mode );
26</PRE></DD></DL>
27
28<H2>Arguments</H2>
29<TABLE class="arguments" border="1">
30  <TR>
31<TH><STRONG><EM><CODE>heap</CODE></EM></STRONG></TH>
32<TD>Frame heap handle</TD>
33  </TR>
34  <TR>
35<TH>mode</TH>
36<TD>Memory block deallocation method (see below)</TD>
37  </TR>
38</TABLE>
39
40<H2>Return Values</H2>
41<P>None.</P>
42
43<H2>Description</H2>
44<P>This function frees memory blocks in bulk. The <SPAN class="argument">mode</SPAN> specifies how to free memory. The following values can be assigned to <SPAN class="argument">mode</SPAN>.</P>
45<TABLE class="arguments" border="1">
46  <TR>
47<TH><CODE>MEM_FRMHEAP_FREE_HEAD</CODE></TH>
48<TD>Frees memory block groups allocated from the bottom of the heap region.</TD>
49  </TR>
50  <TR>
51<TH><CODE>MEM_FRMHEAP_FREE_TAIL</CODE></TH>
52<TD>Frees memory block groups allocated from the top of the heap region.</TD>
53  </TR>
54  <TR>
55<TH><CODE>MEM_FRMHEAP_FREE_ALL</CODE></TH>
56<TD>Simultaneously deallocates all allocated memory blocks from the heap. This is equivalent to specifying both <CODE>MEM_FRMHEAP_FREE_HEAD</CODE> and <CODE>MEM_FRMHEAP_FREE_TAIL</CODE> simultaneously.</TD>
57  </TR>
58</TABLE>
59
60<H2>See Also</H2>
61<P class="reference">
62<A href="MEMAllocFromFrmHeap.html">MEMAllocFromFrmHeap</A>,
63<A href="MEMAllocFromFrmHeapEx.html">MEMAllocFromFrmHeapEx</A>
64</P>
65
66<H2>Revision History</H2>
67<P>
682006/03/01 Initial version.<BR>
69</P>
70
71<hr><p>CONFIDENTIAL</p></body>
72</HTML>
73