WSASetEvent

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

Syntax

BOOL WSASetEvent(
         WSAEVENT hEvent
)

Parameters

hEvent
Type: WSAEVENT 

[in] Handle that identifies an open event object.

Return value

Type: BOOL 

If the 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 WSASetEvent function sets the state of the event object to be signaled.

Windows Phone 8: This API is supported.

Requirements

Header: Declared in winsock2.h.

Library: Use ws2_32.lib.