Sets the specified event object to the signaled state.

BOOLEAN SetEvent(
    HANDLE hEvent
);

BOOLEAN RtSetEvent(
    HANDLE hEvent
);

Parameters

hEvent

Handle to the event object. CreateEvent returns this handle.

Remarks

RtSetEvent can also be used from a Windows application to set an iwin32 event.

SetEvent returns FALSE if the handle to the event object is invalid.

The state of a manual-reset event object remains signaled until set explicitly to the nonsignaled state by ResetEvent. Any number of waiting threads, or threads that subsequently begin wait operations for the specified event object by calling a wait function, can be released while the object's state is signaled.

The state of an auto-reset event object remains signaled until a single waiting thread is released, at which time the system automatically sets the state to nonsignaled. If no threads are waiting, the event object's state remains signaled.

It is not an error to use SetEvent on an event already in the signaled state.

Return Values

Non-zero

Success.

0 (zero)

Failure. For extended error information, see GetLastError.

Requirements

Notes

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

See Also

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