Skip to content

Latest commit

 

History

History
116 lines (81 loc) · 3.51 KB

nf-synchapi-resetevent.md

File metadata and controls

116 lines (81 loc) · 3.51 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:synchapi.ResetEvent
ResetEvent function (synchapi.h)
Sets the specified event object to the nonsignaled state.
ResetEvent
ResetEvent function
_win32_resetevent
base.resetevent
synchapi/ResetEvent
winbase/ResetEvent
base\resetevent.htm
base
bba7caab-d1ed-4261-aeca-49f847458f4c
12/05/2018
ResetEvent, ResetEvent function, _win32_resetevent, base.resetevent, synchapi/ResetEvent, winbase/ResetEvent
synchapi.h
Windows.h on Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2
Windows
Windows XP [desktop apps \| UWP apps]
Windows Server 2003 [desktop apps \| UWP apps]
Kernel32.lib
Kernel32.dll
Windows
19H1
ResetEvent
synchapi/ResetEvent
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
API-MS-Win-Core-Synch-l1-1-0.dll
KernelBase.dll
API-MS-Win-Core-Synch-l1-2-0.dll
API-MS-Win-Core-Synch-l1-2-1.dll
API-MS-Win-DownLevel-Kernel32-l1-1-0.dll
MinKernelBase.dll
ResetEvent

ResetEvent function

-description

Sets the specified event object to the nonsignaled state.

-parameters

-param hEvent [in]

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

The handle must have the EVENT_MODIFY_STATE access right. For more information, see Synchronization Object Security and Access Rights.

-returns

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 an event object remains nonsignaled until it is explicitly set to signaled by the SetEvent or PulseEvent function. This nonsignaled state blocks the execution of any threads that have specified the event object in a call to one of the wait functions.

The ResetEvent function 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.

Resetting an event that is already reset has no effect.

-see-also

CreateEvent

Event Objects

OpenEvent

PulseEvent

SetEvent

Synchronization Functions