OS_DumpArenaInfo

Syntax

#include <nitro/os.h>

void OS_DumpArenaInfo( OSArenaId id, BOOL isInfoLine );

Arguments

id	Arena ID
*isInfoLine*	Whether to show descriptions of each item.

Return Values

None.

Description

Displays the arena information.
This function is intended for debugging, so it won't do anything in FINALROM builds. It will not generate any code.

This function is used to display information about a single arena. In order to display information about all arenas at once, call the OS_DumpAllArenaInfo function.

id is an enumerated type of type OSArenaId and indicates which arena to display information about. Refer to OS_InitArena() for details of the values that can be obtained.

isInfoLine indicates whether to display a line explaining each item when displaying the arena information. If this is TRUE, the explanatory line will be displayed. If this is FALSE, the explanatory line will not be displayed.

Example

If the following is run:
OS_DumpArenaInfo( OS_ARENA_MAIN, TRUE );

(Display results)
  NAME         ID    LO addr    HI addr      size
 MainRAM-main   0   020109a0   02f80000    f6f660

Example

If the following is run:
OS_DumpArenaInfo( OS_ARENA_MAIN, TRUE ); OS_DumpArenaInfo( OS_ARENA_MAINEX, FALSE );

(Display results)
  NAME         ID    LO addr    HI addr      size
 MainRAM-main   0   020109a0   02f80000    f6f660
 MainEX         2   0d000000   0df00000    f00000

Display Mode

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 OS_SetPrintBlockingMode for details.

Revision History

2009/07/27 Added Display Mode.
2008/01/29 Initial version.

CONFIDENTIAL