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>MEMRecordStateForFrmHeap</TITLE>
12
13</HEAD>
14
15
16<BODY>
17
18
19<H1>MEMRecordStateForFrmHeap</H1>
20
21<H2>Syntax</H2>
22<DL><DD><PRE class="construction">
23#include &lt;revolution/mem.h&gt;
24
25BOOL MEMRecordStateForFrmHeap(
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 state record</TD>
39  </TR>
40</TABLE>
41
42<H2>Return Values</H2>
43<P>Returns <CODE>TRUE</CODE> if the status was recorded. Returns <CODE>FALSE</CODE> if the function failed at recording it.</P>
44
45<H2>Description</H2>
46<P>This function records the current memory use state of the frame heap. It can be restored to the recorded memory use state by calling the<A href="MEMFreeByStateToFrmHeap.html"><CODE>MEMFreeByStateToFrmHeap</CODE></A> function.</P>
47<P>A tag can be attached to the state record. To attach a tag, set <SPAN class="argument">tagName</SPAN> to a nonzero value. If <SPAN class="argument">tagName</SPAN> is set to zero, no tag is attached. No error results even if the same tag value has been specified for an existing status record already. When multiple status records have the same tag value, specified with an argument in the <A href="MEMFreeByStateToFrmHeap.html"><CODE>MEMFreeByStateToFrmHeap</CODE></A> function, the tag for the most recently recorded status record is used.</P>
48<P>Several bytes from the bottom of the available region are used to record the state. The function fails if it cannot allocate memory for recording.</P>
49
50<H2>See Also</H2>
51<P class="reference">
52<A href="MEMFreeByStateToFrmHeap.html">MEMFreeByStateToFrmHeap</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