Edit

WSK_DATAGRAM_INDICATION structure (wsk.h)

  • Article

The WSK_DATAGRAM_INDICATION structure describes a datagram that has been received on a datagram socket.

Syntax

typedef struct _WSK_DATAGRAM_INDICATION {
  struct _WSK_DATAGRAM_INDICATION *Next;
  WSK_BUF                         Buffer;
  PCMSGHDR                        ControlInfo;
  ULONG                           ControlInfoLength;
  PSOCKADDR                       RemoteAddress;
} WSK_DATAGRAM_INDICATION, *PWSK_DATAGRAM_INDICATION;

Members

Next

A pointer to the next WSK_DATAGRAM_INDICATION structure in a linked list of WSK_DATAGRAM_INDICATION structures. If this member is NULL, this structure is the last WSK_DATAGRAM_INDICATION structure in the linked list.

Buffer

A WSK_BUF structure that describes a datagram that has been received on the socket.

ControlInfo

The control information that is associated with the received datagram. The control information data that is associated with a datagram is made up of one or more control data objects, each of which begins with a CMSGHDR structure. If there is no control information present for the received datagram, this member is NULL.

ControlInfoLength

The size of the control information that is associated with the received datagram. If this value is zero, there is no control information present for the datagram.

RemoteAddress

A pointer to a buffer that contains the remote transport address from which the received datagram originated. The buffer contains the specific SOCKADDR structure type that corresponds to the address family that the WSK application specified when it created the datagram socket.

Remarks

The WSK subsystem passes a pointer to a WSK_DATAGRAM_INDICATION structure as the DataIndication parameter when it calls a datagram socket's WskReceiveFromEvent event callback function.

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

CMSGHDR

SOCKADDR

WSK_BUF

WskReceiveFromEvent

WskRelease