MEMRecordStateForFrmHeap

Syntax

#include <revolution/mem.h>

BOOL MEMRecordStateForFrmHeap( 
                         MEMHeapHandle     heap, 
                         u32               tagName );

Arguments

*`heap`*	Frame heap handle
*`tagName`*	Tag attached to the state record

Return Values

Returns TRUE if the status was recorded. Returns FALSE if the function failed at recording it.

Description

This function records the current memory use state of the frame heap. It can be restored to the recorded memory use state by calling theMEMFreeByStateToFrmHeap function.

A tag can be attached to the state record. To attach a tag, set tagName to a nonzero value. If tagName is set to zero, no tag is attached. No error results even if the same tag value has been specified for an existing status record already. When multiple status records have the same tag value, specified with an argument in the MEMFreeByStateToFrmHeap function, the tag for the most recently recorded status record is used.

Several bytes from the bottom of the available region are used to record the state. The function fails if it cannot allocate memory for recording.

Revision History

2006/03/01 Initial version.