SocketNotificationRetrieveEvents function (winsock2.h)
This inline helper function is provided as a convenience to retrieve the events mask from an OVERLAPPED_ENTRY.
For more info, and code examples, see Winsock socket state notifications.
Syntax
UINT32 SocketNotificationRetrieveEvents(
OVERLAPPED_ENTRY *notification
);
Parameters
notification
Type: _In_ OVERLAPPED_ENTRY*
A pointer to an OVERLAPPED_ENTRY received for a socket state notification.
Return value
A UINT32 containing a bitmask of the notification events for the socket.
This table lists the socket notification events. These are the events possible when a notification is received.
| Event | Description |
|---|---|
| SOCK_NOTIFY_EVENT_IN | Input is available from the socket without blocking. |
| SOCK_NOTIFY_EVENT_OUT | Output can be provided to the socket without blocking. |
| SOCK_NOTIFY_EVENT_HANGUP | The socket connection has terminated. |
| SOCK_NOTIFY_EVENT_ERR | The socket is in an error state. |
| SOCK_NOTIFY_EVENT_REMOVE | The notification has been deregistered. |
Remarks
The SOCK_NOTIFY_EVENT_ERR and SOCK_NOTIFY_EVENT_REMOVE events might be indicated regardless of registered event filter.
If a SOCK_NOTIFY_EVENT_REMOVE event is indicated, then no more notifications will be provided.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 10 Build 20348 |
| Minimum supported server | Windows 10 Build 20348 |
| Header | winsock2.h |
| Library | Ws2_32.lib |
| DLL | Ws2_32.dll |