Method UnlockPayloadBuffer
UnlockPayloadBuffer(PayloadHandle, PayloadLockContext)
Releases an existing Payload Lock on the specified buffer for a given context.
Declaration
public bool UnlockPayloadBuffer(PayloadHandle handle, PayloadLockContext context)Parameters
| Type | Name | Description |
|---|---|---|
| PayloadHandle | handle | A valid PayloadHandle value for the Payload buffer to unlock. |
| PayloadLockContext | context | Value returned by preceding call to LockPayloadBuffer(PayloadHandle). |
Returns
| Type | Description |
|---|---|
| bool | True if unlock operation was successful or not. |
Remarks
Each call to LockPayloadBuffer(PayloadHandle) generates a unique context value for a given buffer and Unlock must called for each context before the buffer can be safely released. While it's still possible to "force" release a locked Payload buffer, this isn't recommended.
If the specified buffer wasn't locked for this specific context, the unlock operation will fail.