Method ReleasePayload

ReleasePayload(PayloadHandle)

Releases the memory block referenced by the specified handle.

Declaration

public bool ReleasePayload(PayloadHandle payloadHandle)

Parameters

Type	Name	Description
PayloadHandle	payloadHandle	Handle value that references the memory block to be released.

Returns

Type	Description
bool	True if successful and false if not.

Remarks

This method doesn't actually release the memory but instead marks the block as being "freed". The memory is actually released by ReclaimReleasedPayloadBlocks(), which must be called from a system Update.