MEMGetBaseHeapHandle

Syntax

#include <cafe/mem.h>

MEMHeapHandle MEMGetBaseHeapHandle (MEMArena arena);

Parameters

arena Arena for which the base heap handle is to be retrieved (MEM_ARENA_1, MEM_ARENA_2, ...).

Return Values

If successful, this function returns the handle to the base heap for the specified memory arena. Otherwise, zero is returned.

Description

This function returns the handle to the base heap for a memory type designated by logical arena name.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

MEMSetBaseHeapHandle
MEMGetArena

Revision History

2013-05-08 Automated cleanup pass.
2010-11-01 Initial version.


CONFIDENTIAL