MEMGetHeapType

Syntax

#include <cafe/mem.h>

static inline MEMHeapType
MEMGetHeapType( MEMHeapHandle heap )

Parameters

heap Heap handle for determining the heap type.

Return Values

Returns the heap type of the heap handle passed as an argument.

Description

Obtains the heap type of the heap handle passed as an argument. The following values are returned based on the heap type.

MEM_HEAP_TYPE_EXP Heap handle of expanded heap.
MEM_HEAP_TYPE_FRM Heap handle of frame heap.
MEM_HEAP_TYPE_UNIT Heap handle of unit heap.
MEM_HEAP_TYPE_USER Heap handle of user-defined heap.
MEM_HEAP_TYPE_UNKNOWN Heap handle is invalid because it was not initialized or it has been deleted.


Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

MEMIsExpHeap
MEMIsFrmHeap
MEMIsUnitHeap

Revision History

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


CONFIDENTIAL