RtkPulseEvent

RtkPulseEvent provides a single operation that sets the state of the specified event object to signaled and then resets it to non-signaled after releasing the appropriate number of waiting threads.

Syntax

NTSTATUS RtkPulseEvent(
    [in]    RTSSINST RtssInst,
    [in]    HANDLE EventHandle,
);

Parameters

[in] RtssInst

An RTSSINST value returned from a call to RtkRtssAttach or RtkRtssAttachEx. Pass a valid RTSSINST value or the call will fail with STATUS_INVALID_PARAMETER.

[in] EventHandle

The handle that identifies the event object is returned by a preceding call to RtkCreateEvent or RtkOpenEvent.

Return Value

If the function succeeds, it returns STATUS_SUCCESS. If the function fails, it returns one of the following NTSTATUS error codes:

• STATUS_INVALID_PARAMETER
• STATUS_UNSUCCESSFUL
• STATUS_INVALID_HANDLE

Remarks

All waiting threads that can be released are released for a manual-reset event object. The function then resets the event object's state to non-signaled and returns.

For an auto-reset event object, the function resets the state to non-signaled and returns after releasing a single waiting thread, even if multiple threads are waiting.

If no threads are waiting or cannot be released immediately, RtkPulseEvent simply sets the event object's state to non-signaled and returns.

Requirements

See Also:

• RtkCreateEvent
• RtkOpenEvent
• RtkResetEvent
• RtkSetEvent
• RtkWaitForSingleObject
• RtkWaitForMultipleObjects