RtSetEvent

RtSetEvent sets the state of the specified event object to signaled.

Syntax

BOOL RtSetEvent(
    HANDLE hEvent
);

Parameters

hEvent

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

Return Value

TRUE if the function succeeds, FALSE if the function fails

To get extended error information, call GetLastError.

Remarks

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

In the case of an auto-reset event object, the RtSetEvent function resets the state to non-signaled and returns after releasing, or the event remains signaled until a single waiting thread is released, at which time the system automatically sets the state to non-signaled. If no threads are waiting, the event object's state remains signaled.

Requirements

Minimum Supported Version RTX64 2013
Header Rtapi.h
Library RtApi.lib (Windows), Rtx_Rtss.lib (RTSS)

See Also:

RtCreateEvent

RtOpenEvent

RtPulseEvent

RtResetEvent