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<H2>Syntax</H2>
22<DL><DD><PRE class="construction">
23#include &lt;revolution/mem.h&gt;
24
25BOOL MEMCheckExpHeap(
26              MEMHeapHandle     heap,
27              u32               optFlag );
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>Expanded heap handle</TD>
35  </TR>
36  <TR>
37<TH><STRONG><EM><CODE>optFlag</CODE></EM></STRONG></TH>
38<TD>Check options (explained below)</TD>
39  </TR>
40</TABLE>
41
42<H2>Return Values</H2>
43<P>Returns <CODE>TRUE</CODE> if no errors are found in the expanded heap. If errors were found, returns <CODE>FALSE</CODE>.</P>
44
45<H2>Description</H2>
46<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>
47<P>Specify the check options with the <SPAN class="argument">optFlag</SPAN> argument.</P>
48<TABLE class="arguments" border="1">
49  <TR>
50<TH><CODE>MEM_HEAP_ERROR_PRINT</CODE></TH>
51<TD>If an error is found in a heap, the error content is output using the <CODE>OSReport</CODE> function.</TD>
52  </TR>
53</TABLE>
54<P>This function is for debugging. In the final ROM version (<code>FINALROM</code>) library, this function does not do anything and always returns <code>TRUE</code>.</P>
55
56<H2>See Also</H2>
57<P class="reference">
58<A href="MEMCheckForMBlockExpHeap.html"><CODE>MEMCheckForMBlockExpHeap</CODE></A>
59</P>
60
61<H2>Revision History</H2>
62<P>
632006/03/01 Initial version.<BR>
64</P>
65
66<hr><p>CONFIDENTIAL</p></body>
67</HTML>
68