MEMSetBaseHeapHandle

Syntax

#include <cafe/mem.h>

MEMHeapHandle MEMSetBaseHeapHandle (MEMArena arena, MEMHeapHandle heap);

Parameters

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

Return Values

If successful this function returns the previously set base heap for a memory arena, or the MEM_HEAP_INVALID_HANDLE otherwise.

Description

This function allows you to specify the heap that is to be use for all base allocations for a memory arena.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

MEMGetBaseHeapHandle
MEMGetArena

Revision History

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


CONFIDENTIAL