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	<!-- �^�C�g���� -->
12	<TITLE>MEMRecordStateForFrmHeap</TITLE>
13
14</HEAD>
15
16
17<BODY>
18
19
20<!-- �^�C�g���� -->
21<H1>MEMRecordStateForFrmHeap</H1>
22
23
24<H2>C Specification</H2>
25<PRE class="construction">#include &lt;revolution/mem.h&gt;
26
27BOOL MEMRecordStateForFrmHeap(
28MEMHeapHandle    heap,
29u32              tagName );</PRE>
30
31
32<H2>Arguments</H2>
33<TABLE border="1">
34
35    <TR>
36	<TD><STRONG><EM><CODE>heap</CODE></EM></STRONG></TD>
37	<TD>Frame heap handle.</TD>
38</TR>
39    <TR>
40<TD><STRONG><EM><CODE>tagName</CODE></EM></STRONG></TD>
41<TD>Tag attached to the state record.</TD>
42    </TR>
43  </TABLE>
44
45
46<H2>Return Values</H2>
47<P>Returns <CODE>TRUE</CODE> if the state was recorded. Otherwise, returns <CODE>FALSE</CODE>.</P>
48<H2>Description</H2>
49<P>This function records the current memory use state of the frame heap. A memory use state that was recorded can be restored by calling <a href="MEMFreeByStateToFrmHeap.html"><code>MEMFreeByStateToFrmHeap</code></a>.</P>
50<P>A tag can be attached to the state record. To attach a tag, set <STRONG><EM><CODE>tagName</CODE></EM></STRONG> to a nonzero value.&nbsp;If <STRONG><EM><CODE>tagName</CODE></EM></STRONG> is set to zero, no tag is attached.&nbsp;Furthermore, no error results even if the same tag value is specified for an existing state record. When multiple state records have the same tag values specified in the <a href="MEMFreeByStateToFrmHeap.html"><code>MEMFreeByStateToFrmHeap</code></a> function, the tag for the most recently recorded state record is used.</P>
51<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>
52<H2>See Also</H2>
53<P class="reference"><A href="MEMFreeByStateToFrmHeap.html"><CODE>MEMFreeByStateToFrmHeap</CODE></A></P>
54
55
56<H2>Revision History</H2>
57<P>03/01/2006 Initial version.</P>
58
59
60</BODY>
61</HTML>
62