MEMFreeToFrmHeap

C Specification

#include <revolution/mem.h>

void MEMFreeToFrmHeap( MEMHeapHandle heap, int mode );

Arguments

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

Return Values

None.

Description

This function frees memory blocks in bulk. The deallocation method is set with mode. You can specify the following values for 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 frees all allocated memory blocks from the heap. This function and setting MEM_FRMHEAP_FREE_HEAD and MEM_FRMHEAP_FREE_TAIL are at the same time are the same.

See Also

MEMAllocFromFrmHeap, MEMAllocFromFrmHeapEx

Revision History

03/01/2006 Initial version.