Sets the specified event object to signal, and then resets it to nonsignaled after releasing the appropriate number of waiting threads.

BOOLEAN PulseEvent(
    HANDLE hEvent
);

BOOLEAN RtPulseEvent(
    HANDLE hEvent
);

Parameters

hEvent

Handle to the event object. CreateEvent 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 GetLastError.

Requirements

Notes

• In the iwin32 API, PulseEvent and RtPulseEvent are synonyms.
• This function operates in the real-time portion of your application.
• The iwin32x API also includes an RtPulseEvent function that operates in the Windows portion of your application.

See Also

CreateEvent, OpenEvent, ResetEvent, SetEvent, WaitForSingleObject, iwin32 API, iwin32 Overview