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_DumpArenaInfo</TITLE>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">OS_DumpArenaInfo <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_DumpArenaInfo( OSArenaId id, BOOL isInfoLine );
17</CODE></PRE>
18</DL>
19<H2>Arguments</H2>
20<TABLE border="1" width="100%">
21  <TBODY>
22    <TR>
23<TD width="13%"><EM><STRONG>id</STRONG></EM></TD>
24<TD width="87%">Arena ID</TD>
25    </TR>
26    <TR>
27<TD><B><I>isInfoLine</I></B></TD>
28<TD>Whether to show descriptions of each item.</TD>
29    </TR>
30  </TBODY>
31</TABLE>
32<H2>Return Values</H2>
33<P>None.</P>
34<H2>Description</H2>
35<P>Displays the arena information.<BR>This function is intended for debugging, so <FONT color="#ff0000">it won't do anything in FINALROM builds</FONT>. It will not generate any code.</P>
36<P>This function is used to display information about a single arena. In order to display information about all arenas at once, call the <CODE><A href="OS_DumpAllArenaInfo.html">OS_DumpAllArenaInfo</A></CODE> function.</P>
37<P><B><I>id</I></B> is an enumerated type of type <CODE>OSArenaId</CODE> and indicates which arena to display information about. Refer to <CODE><A href="OS_InitArena.html">OS_InitArena()</A></CODE> for details of the values that can be obtained.</P>
38<P><B><I>isInfoLine</I></B> indicates whether to display a line explaining each item when displaying the arena information. If this is <CODE>TRUE</CODE>, the explanatory line will be displayed. If this is <CODE>FALSE</CODE>, the explanatory line will not be displayed.</P>
39<P><B>Example</B></P>
40<BLOCKQUOTE style="background: #ffffc0;"><BR> If the following is run:<BR><CODE>OS_DumpArenaInfo( OS_ARENA_MAIN, <FONT color="#ff0000">TRUE</FONT> );</CODE><BR> <BR> (Display results)
41<PRE>  NAME         ID    LO addr    HI addr      size
42 MainRAM-main   0   020109a0   02f80000    f6f660
43
44</PRE>
45</BLOCKQUOTE>
46<P><B>Example</B></P>
47<BLOCKQUOTE style="background: #ffffc0;"><BR> If the following is run:<BR><CODE>OS_DumpArenaInfo( OS_ARENA_MAIN, <FONT color="#ff0000">TRUE</FONT> );<BR> OS_DumpArenaInfo( OS_ARENA_MAINEX, <FONT color="#ff0000">FALSE</FONT> );</CODE> <BR> <BR> (Display results)
48
49<PRE>  NAME         ID    LO addr    HI addr      size
50 MainRAM-main   0   020109a0   02f80000    f6f660
51 MainEX         2   0d000000   0df00000    f00000
52
53
54</PRE>
55</BLOCKQUOTE>
56<H3><BR> Display Mode</H3>
57<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>
58<H2>See Also</H2>
59<P><CODE><A href="OS_DumpAllArenaInfo.html">OS_DumpAllArenaInfo</A><BR> <A href="../debug/OS_SetPrintBlockingMode.html">OS_SetPrintBlockingMode</A><BR></CODE></P>
60<H2>Revision History</H2>
61<P>2009/07/27 Added <B>Display Mode</B>.<BR> 2008/01/29 Initial version.</P>
62<hr><p>CONFIDENTIAL</p></body>
63</HTML>