MEMFreeByStateToFrmHeap

C Specification

#include <revolution/mem.h>

BOOL MEMFreeByStateToFrmHeap( 
MEMHeapHandle    heap,
u32              tagName );

Arguments

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

Return Values

Returns TRUE if the memory block that the state record uses is successfully freed. Otherwise, returns FALSE.

Description

This function frees memory that is allocated after the state is recorded. If 0 is specified for tagName, the state record from the previous call to the MEMRecordStateForFrmHeap function is used. If a value other than 0 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 state isn't 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