# OS_DumpHeap

## Syntax

      #include <nitro/os.h>

      void OS_DumpHeap( OSArenaId id, OSHeapHandle heap );

## Arguments

id | Arena ID of the arena that is associated with the heap to be displayed.
heap | Handle of the heap to be displayed.

## Return Values

None.

## Description

This function displays information in the heap for debugging. This function is used for debugging.

You must specify an arena that has a heap. The arena is specified with the arena ID (id). To read more about this value, see `OS_InitArena`.

###
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.

## See Also

`OS_InitArena, OS_InitAlloc
OS_SetPrintBlockingMode()
`

## Revision History

2009/07/27 Added Display Mode.
2004/01/06 Initial version.

CONFIDENTIAL