 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function sets the state of the specified event object to nonsignaled.
BOOL ResetEvent( HANDLE hEvent );
Parameters
- hEvent
- Handle to the event object. The
CreateEventfunction
returns this handle.
Return Values
Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.
Remarks
ResetEventreturns FALSE if the handle to the event object is invalid.
The state of an event object remains nonsignaled until it is explicitly set to signaled by the SetEventor PulseEventfunction. This nonsignaled state blocks the execution of any threads that have specified the event object in a call to one of the wait functions.
ResetEventsets the event to the nonsignaled state even if the event was signaled multiple times before being reset.
The ResetEventfunction 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 nonsignaled after a single waiting thread is released.
Requirements
Runs on Versions Defined in Include Link to Windows CE OS 1.0 and later Kfuncs.h Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
CreateEvent, PulseEvent, SetEvent