WSK_CLIENT_DISPATCH structure (wsk.h)

The WSK_CLIENT_DISPATCH structure specifies a WSK application's dispatch table of event callback functions for events that are not specific to a particular socket.

Syntax

typedef struct _WSK_CLIENT_DISPATCH {
  USHORT               Version;
  USHORT               Reserved;
  PFN_WSK_CLIENT_EVENT WskClientEvent;
} WSK_CLIENT_DISPATCH, *PWSK_CLIENT_DISPATCH;

Members

Version

The version of the WSK Network Programming Interface (NPI) that the WSK application would like to use.

Reserved

Reserved for system use. WSK applications must set this member to zero.

WskClientEvent

A pointer to the WSK application's WskClientEvent event callback function. If a WSK application does not implement a WskClientEvent event callback function, this member must be set to NULL.

Remarks

When a WSK application calls the WskRegister function, it provides a pointer to an initialized WSK_CLIENT_DISPATCH structure by means of the Dispatch member of the WSK_CLIENT_NPI structure pointed to by the WskClientNpi parameter.

The major and minor version numbers that are contained within the Version member are encoded by using the MAKE_WSK_VERSION macro:

Version = MAKE_WSK_VERSION(Major,Minor);

The major and minor version numbers can be extracted from the Version member by using the WSK_MAJOR_VERSION and WSK_MINOR_VERSION macros:

Major = WSK_MAJOR_VERSION(Version);
Minor = WSK_MINOR_VERSION(Version);

For more information about attaching a WSK application to the WSK subsystem, see Registering a Winsock Kernel Application.

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

WSK_CLIENT_NPI

WSK_PROVIDER_DISPATCH

WSK_PROVIDER_NPI

WskClientEvent

WskRegister