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>MEMFreeByStateToFrmHeap</TITLE>
12
13</HEAD>
14
15
16<BODY>
17
18
19<H1>MEMFreeByStateToFrmHeap</H1>
20
21<H2>Syntax</H2>
22<DL><DD><PRE class="construction">
23#include &lt;revolution/mem.h&gt;
24
25BOOL MEMFreeByStateToFrmHeap(
26                        MEMHeapHandle    heap,
27                        u32              tagName );
28</PRE></DD></DL>
29
30<H2>Arguments</H2>
31<TABLE class="arguments" border="1">
32  <TR>
33<TH><STRONG><EM><CODE>heap</CODE></EM></STRONG></TH>
34<TD>Frame heap handle</TD>
35  </TR>
36  <TR>
37<TH><STRONG><EM><CODE>tagName</CODE></EM></STRONG></TH>
38<TD>Tag attached to the status record</TD>
39  </TR>
40</TABLE>
41
42<H2>Return Values</H2>
43<P>Returns <CODE>TRUE</CODE> if memory blocks were successfully deallocated using the status record. Returns <CODE>FALSE</CODE> if it fails.</P>
44
45<H2>Description</H2>
46<P>Deallocates memory allocated since the record state. If <code>0</code> is specified for <SPAN class="argument">tagName</SPAN>, the state recorded from the previous call to the <A href="MEMRecordStateForFrmHeap.html"><CODE>MEMRecordStateForFrmHeap</CODE></A> function is used. If a non-zero value is specified, the state record associated with the tag value is used. If multiple tags share the same value, the previously recorded state record is used.</P>
47<P>If <SPAN class="argument">tagName</SPAN> is 0 and a status has never been recorded, the function fails. The function also fails if a state record with the specified tag value doesn't exist.</P>
48<P>If the tag value is set and freed, state records that are saved after this record with the same tag value are deleted.</P>
49
50<H2>See Also</H2>
51<P class="reference">
52<A href="MEMRecordStateForFrmHeap.html">MEMRecordStateForFrmHeap</A>
53</P>
54
55<H2>Revision History</H2>
56<P>
572006/03/01 Initial version.<BR>
58</P>
59
60<hr><p>CONFIDENTIAL</p></body>
61</HTML>
62