MEMFreeByStateToFrmHeap

Syntax

#include <revolution/mem.h>

BOOL MEMFreeByStateToFrmHeap( 
                        MEMHeapHandle    heap, 
                        u32              tagName );

Arguments

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

Return Values

Returns TRUE if memory blocks were successfully deallocated using the status record. Returns FALSE if it fails.

Description

Deallocates memory allocated since the record state. If 0 is specified for tagName, the state recorded from the previous call to the MEMRecordStateForFrmHeap function is used. If a non-zero value is specified, the state record associated with the tag value is used. If multiple tags share the same value, the previously recorded state record is used.

If tagName is 0 and a status has never been recorded, the function fails. The function also fails if a state record with the specified tag value doesn't exist.

If the tag value is set and freed, state records that are saved after this record with the same tag value are deleted.

Revision History

2006/03/01 Initial version.