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>MEMCheckExpHeap</TITLE>
12
13</HEAD>
14
15
16<BODY>
17
18
19<H1>MEMCheckExpHeap</H1>
20
21
22<H2>C Specification</H2>
23<PRE class="construction">#include &lt;revolution/mem.h&gt;
24
25BOOL MEMCheckExpHeap(
26              MEMHeapHandle     heap,
27              u32               optFlag );</PRE>
28
29
30<H2>Arguments</H2>
31<TABLE border="1">
32
33    <TR>
34	<TD><STRONG><EM><CODE>heap</CODE></EM></STRONG></TD>
35	<TD>Expanded heap handle.</TD>
36</TR>
37    <TR>
38<TD><STRONG><EM><CODE>optFlag</CODE></EM></STRONG></TD>
39<TD>Check options (explained below).</TD>
40    </TR>
41  </TABLE>
42
43
44<H2>Return Values</H2>
45<P>Returns <CODE>TRUE</CODE> if no errors are found in the expanded heap. Otherwise returns <CODE>FALSE</CODE>.</P>
46<H2>Description</H2>
47<P>This function checks whether the expanded heap is corrupted. Specifically, this function checks whether the management region for each memory block in the expanded heap is normal.</P>
48<P>Specify the check option with the <STRONG><EM><CODE>optFlag</CODE></EM></STRONG> argument.</P>
49<TABLE border="1">
50
51    <TR>
52<TD><CODE>MEM_HEAP_ERROR_PRINT</CODE></TD>
53<TD>If an error is found in a heap, the error content is output using the <CODE>OSReport()</CODE> function.</TD>
54    </TR>
55
56</TABLE>
57<P>This function is for debugging. The final ROM version (<code>FINALROM</code>) library does not do anything and always returns <code>TRUE</code>.</P>
58<H2>See Also</H2>
59<P class="reference"><A href="MEMCheckForMBlockExpHeap.html"><CODE>MEMCheckForMBlockExpHeap</CODE></A></P>
60
61
62<H2>Revision History</H2>
63<P>2006/03/01 Initial version.</P>
64
65
66<hr>
67<P>CONFIDENTIAL</p>
68</BODY>
69</HTML>
70