SetEvent

The SetEvent function sets the state of the specified event object to signaled.

BOOL SetEvent(
  HANDLE hEvent   // handle to event object
);
 

Parameters

hEvent

Handle to the event object. The CreateEvent or OpenEvent function returns this handle.

Windows NT: The handle must have EVENT_MODIFY_STATE access.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. 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 nonsignaled state by the ResetEvent function. Any number of waiting threads, or threads that subsequently begin wait operations for the specified event object by calling one of the wait functions, 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.

Windows CE: Windows CE does not support waiting for a process or thread. Waiting on an invalid handle will return FALSE.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Requires version 1.0 or later.
  Header: Declared in winbase.h.
  Import Library: Use kernel32.lib.

See Also

Synchronization Overview, Synchronization Functions, CreateEvent, OpenEvent, PulseEvent, ResetEvent