MEMFreeToFrmHeap

Syntax

#include <cafe/mem.h>

void MEMFreeToFrmHeap( MEMHeapHandle heap, int mode );

Parameters

heap Frame heap handle.
mode Memory block deallocation method (see below).

Return Values

None.

Description

This function frees memory blocks in bulk. The mode specifies how to free memory. The following values can be assigned to mode.

MEM_FRMHEAP_FREE_HEAD Frees memory block groups allocated from the bottom of the heap region.
MEM_FRMHEAP_FREE_TAIL Frees memory block groups allocated from the top of the heap region.
MEM_FRMHEAP_FREE_ALL Simultaneously deallocates all allocated memory blocks from the heap. This is equivalent to specifying both MEM_FRMHEAP_FREE_HEAD and MEM_FRMHEAP_FREE_TAIL simultaneously.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

MEMAllocFromFrmHeap
MEMAllocFromFrmHeapEx

Revision History

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


CONFIDENTIAL