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
);

notification

A pointer to an OVERLAPPED_ENTRY received for a socket state notification.

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.

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.