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<H1>MEMCheckForMBlockExpHeap</H1>
19
20
21<H2>C Specification</H2>
22<PRE class="construction">#include &lt;revolution/mem.h&gt;
23
24BOOL MEMCheckForMBlockExpHeap(
25const   void*     		memBlock ,
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>memBlock</CODE></EM></STRONG></TD>
35	<TD>Pointer to the memory block to check.</TD>
36</TR>
37    <TR>
38<TD><STRONG><EM><CODE>heap</CODE></EM></STRONG></TD>
39<TD>Expanded heap handle. <CODE>NULL</CODE> can also 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<TD><STRONG><EM><CODE>optFlag</CODE></EM></STRONG></TD>
43<TD>Check options (explained below).</TD>
44    </TR>
45  </TABLE>
46
47
48<H2>Return Values</H2>
49<P>Returns <CODE>TRUE</CODE> if no errors are found in the expanded heap memory block. Otherwise returns <CODE>FALSE</CODE>.</P>
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>Specify the check option with the <STRONG><EM><CODE>optFlag</CODE></EM></STRONG> argument.</P>
53<TABLE border="1">
54
55    <TR>
56<TD><CODE>MEM_HEAP_ERROR_PRINT</CODE></TD>
57<TD>IF a memory block error is found, the error content is output with the <CODE>OSReport</CODE> function.</TD>
58    </TR>
59
60</TABLE>
61<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>
62<H2>See Also</H2>
63<P><A href="MEMCheckExpHeap.html"><CODE>MEMCheckExpHeap</CODE></A></P>
64<H2>Revision History</H2>
65<P>03/01/2006 Initial version.</P>
66
67
68</BODY>
69</HTML>
70