WSAResetEvent function (winsock2.h)

The WSAResetEvent function resets the state of the specified event object to nonsignaled.

Syntax

BOOL WSAAPI WSAResetEvent(
  [in] WSAEVENT hEvent
);

Parameters

[in] hEvent

A handle that identifies an open event object handle.

Return value

If the WSAResetEvent function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information, call WSAGetLastError.

Error code Meaning
WSANOTINITIALISED
A successful WSAStartup call must occur before using this function.
WSAENETDOWN
The network subsystem has failed.
WSAEINPROGRESS
A blocking Windows Sockets 1.1 call is in progress, or the service provider is still processing a callback function.
WSA_INVALID_HANDLE
The hEvent parameter is not a valid event object handle.

Remarks

The WSAResetEvent function is used to set the state of the event object to nonsignaled.

The proper way to reset the state of an event object used with the WSAEventSelect function is to pass the handle of the event object to the WSAEnumNetworkEvents function in the hEventObject parameter. This will reset the event object and adjust the status of active FD events on the socket in an atomic fashion.

Windows Phone 8: This function is supported for Windows Phone Store apps on Windows Phone 8 and later.

Windows 8.1 and Windows Server 2012 R2: This function is supported for Windows Store apps on Windows 8.1, Windows Server 2012 R2, and later.

Requirements

   
Minimum supported client Windows 8.1, Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header winsock2.h
Library Ws2_32.lib
DLL Ws2_32.dll

See also

WSACloseEvent

WSACreateEvent

WSAEnumNetworkEvents

WSAEventSelect

WSASetEvent

Winsock Functions

Winsock Reference