WSAResetEvent

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

Syntax

BOOL WSAResetEvent(
         WSAEVENT hEvent
)  

Parameters

hEvent
Type: WSAEVENT 

[in]

A handle that identifies an open event object handle.

Return value

Type: BOOL 

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.

Return codes
Return code Description
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 API is supported.

Requirements

Header: Declared in winsock2.h.

Library: Use ws2_32.lib.