Sets the specified event object to the nonsignaled state.

BBOOL ResetEvent(
    HANDLE hEvent
);

BOOLEAN RtResetEvent(
    HANDLE hEvent
);

Parameters

hEvent

Handle to the event object. CreateEvent returns this handle.

Remarks

RtResetEvent can also be used from a Windows application to reset an iwin32 event.

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

The state of an event object remains nonsignaled until explicitly set to signaled by SetEvent or PulseEvent. This nonsignaled state blocks execution of any threads that specified the event object in a call to a wait function.

ResetEvent sets the event to the nonsignaled state even if the event was signaled multiple times before being reset.

ResetEvent is used primarily for manual-reset event objects, which must be set explicitly to the nonsignaled state. Auto-reset event objects automatically change from signaled to non-signaled after release of a single waiting thread.

It is not an error to use ResetEvent on an event already in the nonsignaled state.

Return Values

Non-zero

Success.

0 (zero)

Failure. For extended error information, see GetLastError.

Requirements

Notes

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

See Also

CreateEvent, OpenEvent, PulseEvent, SetEvent, iwin32 API, iwin32 Overview