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.
A version of this page is also available for
4/8/2010

This function sets the state of the specified event object to nonsignaled.

Syntax

BOOL ResetEvent(
  HANDLE 
hEvent
);

Parameters

hEvent

[in] Handle to the event object, returned by the CreateEventfunction.

Return Value

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 signaled. The ResetEventfunction is used primarily for manual signal event objects, which must be set explicitly to the nonsignaled state. Auto-signal event objects automatically change from signaled to nonsignaled after a single waiting thread is released.

Each object type, such as memory maps, semaphores, events, message queues, mutexes, and watchdog timers, has its own separate namespace. Empty strings, "", are handled as named objects. On Windows desktop-based platforms, synchronization objects all share the same namespace.

Requirements

Header kfuncs.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also