SOCKET_ADDRESS_LIST structure (ws2def.h)

Article
09/01/2022

The SOCKET_ADDRESS_LIST structure defines a variable-sized list of transport addresses.

Syntax

typedef struct _SOCKET_ADDRESS_LIST {
  INT            iAddressCount;
  SOCKET_ADDRESS Address[1];
} SOCKET_ADDRESS_LIST, *PSOCKET_ADDRESS_LIST, *LPSOCKET_ADDRESS_LIST;

Members

iAddressCount

The number of transport addresses in the list.

Address[1]

A variable-sized array of SOCKET_ADDRESS structures. The SOCKET_ADDRESS structure is defined as follows:

typedef struct _SOCKET_ADDRESS {
  LPSOCKADDR  lpSockaddr;
  INT  iSockaddrLength;
} SOCKET_ADDRESS, *PSOCKET_ADDRESS, *LPSOCKET_ADDRESS;

lpSockaddr

A pointer to a buffer that contains a transport address.

iSockaddrLength

The size, in bytes, of the SOCKADDR structure type that is pointed to by the lpSockaddr member.

Remarks

A WSK application passes a buffer to the WskControlSocket function when the WSK application queries the current list of local transport addresses that match a socket's address family. If the call to the WskControlSocket function succeeds, the buffer contains a SOCKET_ADDRESS_LIST structure followed by the SOCKADDR structures for each of the local transport addresses that match the socket's address family. The WSK subsystem fills in the Address array and sets the iAddressCount member to the number of entries in the array. The lpSockaddr pointers in each of the SOCKET_ADDRESS structures in the array point to the specific SOCKADDR structure type that corresponds to the address family that the WSK application specified when it created the socket.

For more information about querying the current list of local transport addresses, see SIO_ADDRESS_LIST_QUERY.

Requirements

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