1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>OS_DumpHeap</TITLE>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">OS_DumpHeap <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></H1>
12<H2>Syntax</H2>
13<DL>
14  <DD>
15  <PRE><CODE>#include &lt;nitro/os.h&gt;</CODE></PRE>
16  <PRE><CODE>void OS_DumpHeap( OSArenaId id, OSHeapHandle heap );</CODE></PRE>
17</DL>
18<H2>Arguments</H2>
19<TABLE border="1" width="100%">
20  <TBODY>
21    <TR>
22<TD width="13%"><B><I>id</I></B></TD>
23<TD width="87%">Arena ID of the arena that is associated with the heap to be displayed.</TD>
24    </TR>
25    <TR>
26<TD><B><I>heap</I></B></TD>
27<TD>Handle of the heap to be displayed.</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31<H2>Return Values</H2>
32<P>None.</P>
33<H2>Description</H2>
34<P>This function displays information in the heap for debugging. This function is used for debugging.</P>
35<P>You must specify an arena that has a heap. The arena is specified with the arena ID (<em><strong>id</strong></em>). To read more about this value, see <a  href="../arena/OS_InitArena.html"><code>OS_InitArena</code></a>.</P>
36<H3><BR> Display Mode</H3>
37<P>If an accurate display of all information takes priority over speed, as it does in this function, we recommend temporarily setting the display to blocking mode. See <A href="../debug/OS_SetPrintBlockingMode.html"><CODE>OS_SetPrintBlockingMode</CODE></A> for details.</P>
38<H2>See Also</H2>
39<P><CODE><A href="../arena/OS_InitArena.html">OS_InitArena</A>, <A href="OS_InitAlloc.html">OS_InitAlloc</A><BR> <A href="../debug/OS_SetPrintBlockingMode.html">OS_SetPrintBlockingMode()</A><BR></CODE></P>
40<H2>Revision History</H2>
41<P>2009/07/27 Added <B>Display Mode</B>.<BR> 2004/01/06 Initial version.</P>
42<hr><p>CONFIDENTIAL</p></body>
43</HTML>