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>MEMCheckForMBlockExpHeap</TITLE>
12
13</HEAD>
14
15
16<BODY>
17
18
19<H1>MEMCheckForMBlockExpHeap</H1>
20
21<H2>Syntax</H2>
22<DL><DD><PRE class="construction">
23#include &lt;revolution/mem.h&gt;
24
25BOOL MEMCheckForMBlockExpHeap(
26                    const void*       memBlock,
27                    MEMHeapHandle     heap,
28                    u32               optFlag );
29</PRE></DD></DL>
30
31<H2>Arguments</H2>
32<TABLE class="arguments" border="1">
33  <TR>
34<TH><STRONG><EM><CODE>memBlock</CODE></EM></STRONG></TH>
35<TD>Pointer to the memory block to check</TD>
36  </TR>
37  <TR>
38<TH><STRONG><EM><CODE>heap</CODE></EM></STRONG></TH>
39<TD>Expanded heap handle. A <CODE>NULL</CODE> value may be specified. If <CODE>NULL</CODE> is specified, a rough check of the memory block address range and size is performed.</TD>
40  </TR>
41  <TR>
42<TH><STRONG><EM><CODE>optFlag</CODE></EM></STRONG></TH>
43<TD>Check options (explained below)</TD>
44  </TR>
45</TABLE>
46
47<H2>Return Values</H2>
48<P>Returns <CODE>TRUE</CODE> if no errors are found in the expanded heap memory block. If errors were found, returns <CODE>FALSE</CODE>.</P>
49
50<H2>Description</H2>
51<P>This function checks whether a memory block in the expanded heap is corrupted. Specifically, this function checks whether the management region for a memory block in the expanded heap is normal.</P>
52<P>The check options can be specified with the <SPAN class="argument">optFlag</SPAN> argument.</P>
53<TABLE class="arguments" border="1">
54  <TR>
55<TH><CODE>MEM_HEAP_ERROR_PRINT</CODE></TH>
56<TD>If an error is found in the memory block, the error content is output using the <CODE>OSReport</CODE> function.</TD>
57  </TR>
58</TABLE>
59<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>
60
61<H2>See Also</H2>
62<P class="reference">
63<A href="MEMCheckExpHeap.html">MEMCheckExpHeap</A>
64</P>
65
66<H2>Revision History</H2>
67<P>
682006/03/01 Initial version.<BR>
69</P>
70
71<hr><p>CONFIDENTIAL</p></body>
72</HTML>
73