Edit

WSK_EVENT_CALLBACK_CONTROL structure (wsk.h)

  • Article

The WSK_EVENT_CALLBACK_CONTROL structure specifies the information for enabling and disabling a socket's event callback functions.

Syntax

typedef struct _WSK_EVENT_CALLBACK_CONTROL {
  PNPIID NpiId;
  ULONG  EventMask;
} WSK_EVENT_CALLBACK_CONTROL, *PWSK_EVENT_CALLBACK_CONTROL;

Members

NpiId

A pointer to a Network Programming Interface (NPI) identifier that specifies the NPI for the event callback function that is being enabled or disabled. For enabling or disabling any of the standard WSK event callback functions, this member is a pointer to the WSK NPI identifier, NPI_WSK_INTERFACE_ID. For enabling or disabling any event callback functions for an extension interface, this member is a pointer to the NPI identifier for the extension interface.

EventMask

A ULONG value that contains a bitwise OR of event flags for the event callback functions that are being enabled or disabled. For information about the event flags for the standard WSK event callback functions, see SO_WSK_EVENT_CALLBACK.

Remarks

A WSK application can enable any combination of event callback functions for a socket simultaneously by setting the EventMask member to a bitwise OR of the event flags for all of the event callback functions that are being enabled. However, a WSK application must disable event callback functions individually by setting the EventMask member to a bitwise OR of the event flag for the event callback function that is being disabled and the WSK_EVENT_DISABLE flag.

For more information about statically enabling certain event callback functions for all of the sockets that are created by a WSK application, see WSK_SET_STATIC_EVENT_CALLBACKS.

For more information about enabling and disabling a socket's event callback functions, see Enabling and Disabling Event Callback Functions.

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Header wsk.h (include Wsk.h)

See also

SO_WSK_EVENT_CALLBACK

WSK_SET_STATIC_EVENT_CALLBACKS

WskControlClient

WskControlSocket