RtPulseEvent

RtPulseEvent 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

BOOL RtPulseEvent(
    HANDLE hEvent
);

Parameters

hEvent

Identifies the event object. The RtCreateEvent or RtOpenEvent function returns this handle.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE.

To get extended error information, call GetLastError.

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, RtPulseEvent simply sets the event object's state to non-signaled and returns.

See Also:

• RtCreateEvent
• RtOpenEvent
• RtResetEvent
• RtSetEvent