Enum PayloadReleaseResult

Result value returned when releasing Payload buffers.

Namespace: Unity.Logging

Syntax

public enum PayloadReleaseResult

Remarks

Returned by ReleasePayloadBuffer(PayloadHandle, out PayloadReleaseResult, Boolean).

Fields

Name	Description	Value
Success	Payload buffer was successfully released.	0
ForcedRelease	Payload buffer is forced to release even if it's locked or a Disjointed payload railed to release.	1
BufferLocked	Release failed because the PayloadBuffer has been locked.	2
InvalidHandle	Release failed because the passed in PayloadHandle doesn't reference a valid Payload buffer. Typically this means the Payload buffer has already been released.	3
NotInitialized	The LogMemoryManager instance isn't initialized. This implies the PayloadHandle is also invalid because the memory it may have referenced has been released.	4
DisjointedPayloadReleaseFailed	One or more of the Payloads referenced by a Disjointed buffer failed to release. In this case all valid Payloads are released but the Disjointed "head" Payload is not released and the Disjointed buffer handle will remain active. To actually free the Disjointed buffer, ReleasePayloadBuffer(PayloadHandle, out PayloadReleaseResult, Boolean) must be called with "force" release parameter set.	5