For a manual-reset event object, all waiting threads that can be released immediately are released. The function then resets the event object's state to nonsignaled and returns.

For an auto-reset event object, the function resets the state to nonsignaled 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, PulseEvent simply sets the event object's state to nonsignaled and returns.

BOOLEAN RtPulseEvent(
    HANDLE hEvent
);

Parameters

hEvent

Handle to the event object. RtCreateEvent returns this handle.

Remarks

Action differs, depending upon the object:

• Manual-reset event object: all waiting threads that can be released are immediately released. The function then resets the event object's state to nonsignaled and returns.
• Auto-reset event object: the function resets the state to nonsignaled and returns after releasing a single waiting thread, even if multiple threads are waiting.
• No threads waiting or no thread ready for immediate release: sets the event object's state to nonsignaled and returns.

Return Values

Non-zero

Success.

0 (zero)

Failure. For extended error information, see the Windows' GetLastError function.

Requirements

Notes

• This function operates in the Windows portion of your application.
• The iwin32 API also includes an RtPulseEvent function that operates in the real-time portion of your application.

See Also

RtCreateEvent, iwin32x API, iwin32 Overview