#include <cafe/mem.h> BOOL MEMRecordStateForFrmHeap( MEMHeapHandle heap, u32 tagName );
|heap||Frame heap handle.|
|tagName||Tag attached to the state record.|
TRUE if the status was recorded. Returns
FALSE if the function failed at recording it.
This function records the current memory use state of the frame heap. It can be restored to the recorded memory use state by calling the
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.
|Callbacks||Do not call this function from any callback function.|
2013/05/08 Automated cleanup pass.
2010/11/01 Initial version.