NNS_FndFreeByStateToFrmHeap

Syntax

#include <nnsys/fnd.h>
BOOL NNS_FndFreeByStateToFrmHeap(NNSFndHeapHandle heap, u32 tagName);

Arguments

heap Frame heap handle.
tagName Tag name attached to the record state.

Return Values

Returns TRUE if the memory block used by the record state was able to be deallocated. Returns FALSE if the deallocation fails.

Description

Deallocates memory allocated since the record state. The last record state is used if tagName is set to 0. If a value other than 0 is set, the record state associated with that tag value is used. If multiple tags share the same value, the last record state is used.

When tagName is 0, the function will fail if there are no record states. The function will also fail if there is no record state with the designated tag value.

If the tag value is set and deallocated, the states saved after the record state that has that tag value will be gotten rid of.

See Also

NNS_FndRecordStateForFrmHeap

Revision History

2004/10/15 Corrected descriptions in "Arguments", "Return Values", and "Description."
2004/04/01 Initial version.


CONFIDENTIAL