RtkPulseEvent

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

Syntax

NTSTATUS RtkPulseEvent(
    RTSSINST RtssInst,
    HANDLE EventHandle,
);

Parameters

RtssInst

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

EventHandle

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

Return Value

RtkPulseEvent returns STATUS_SUCCESS on success or on failure one of the following NTSTATUS error codes is possible:

STATUS_INVALID_PARAMETER
STATUS_UNSUCCESSFUL
STATUS_INVALID_HANDLE

Remarks

For a manual-reset event object, all waiting threads that can be released are released. 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 if no thread can be released immediately, RtkPulseEvent simply sets the event object's state to non-signaled and returns.

Requirements

Minimum Supported Version	RTX64 2013 with Service Pack 1
Header	RtkApi.h
Library	RtkApi.lib
IRQL	PASSIVE_LEVEL