IP_ADAPTER_GATEWAY_ADDRESS structure

The IP_ADAPTER_GATEWAY_ADDRESS structure stores a single gateway address in a linked list of gateway addresses for a particular adapter.

Syntax


typedef struct _IP_ADAPTER_GATEWAY_ADDRESS {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Reserved;
    };
  };
  struct _IP_ADAPTER_GATEWAY_ADDRESS  *Next;
  SOCKET_ADDRESS                     Address;
} IP_ADAPTER_GATEWAY_ADDRESS, *PIP_ADAPTER_GATEWAY_ADDRESS;

Members

Alignment

Reserved. Used by the compiler to align the structure.

Length

The length, in bytes, of this structure.

Reserved

Reserved.

Next

A pointer to the next gateway address structure in the list.

Address

The IP address for this gateway entry. This member can be an IPv6 address or an IPv4 address.

Remarks

The IP_ADAPTER_ADDRESSES structure is retrieved by the GetAdaptersAddresses function. The FirstGatewayAddress member of the IP_ADAPTER_ADDRESSES structure is a pointer to a linked list of IP_ADAPTER_GATEWAY_ADDRESS structures.

The SOCKET_ADDRESS structure is used in the IP_ADAPTER_GATEWAY_ADDRESS structure. On the Microsoft Windows Software Development Kit (SDK) released for Windows Vista and later, the organization of header files has changed and the SOCKET_ADDRESS structure is defined in the Ws2def.h header file which is automatically included by the Winsock2.h header file. On the Platform Software Development Kit (SDK) released for Windows Server 2003 and Windows XP, the SOCKET_ADDRESS structure is declared in the Winsock2.h header file. In order to use the IP_ADAPTER_GATEWAY_ADDRESS structure, the Winsock2.h header file must be included before the Iphlpapi.h header file.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Iptypes.h (include Iphlpapi.h)

See also

IP Helper Start Page
IP Helper Structures
GetAdaptersAddresses
IP_ADAPTER_ADDRESSES
SOCKET_ADDRESS

 

 

Show: