Edit

IP_ADAPTER_MULTICAST_ADDRESS_XP structure (iptypes.h)

  • Article

The IP_ADAPTER_MULTICAST_ADDRESS structure stores a single multicast address in a linked-list of addresses for a particular adapter.

Syntax

typedef struct _IP_ADAPTER_MULTICAST_ADDRESS_XP {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Flags;
    };
  };
  struct _IP_ADAPTER_MULTICAST_ADDRESS_XP *Next;
  SOCKET_ADDRESS                          Address;
} IP_ADAPTER_MULTICAST_ADDRESS_XP, *PIP_ADAPTER_MULTICAST_ADDRESS_XP;

Members

Alignment

Type: ULONGLONG

Reserved. Used by the compiler to align the structure.

Length

Type: ULONG

The length, in bytes, of this structure.

Flags

Type: DWORD

A set of flags for this multicast IP address.

The following table shows possible values. These constants are defined in the Iptypes.h header file.

Value Meaning
IP_ADAPTER_ADDRESS_DNS_ELIGIBLE
 The IP address is legal to appear in DNS.
IP_ADAPTER_ADDRESS_TRANSIENT
 The IP address is a cluster address and should not be used by most applications.

Next

Type: struct _IP_ADAPTER_MULTICAST_ADDRESS*

A pointer to the next multicast IP address structure in the list.

Address

Type: SOCKET_ADDRESS

The IP address for this multicast IP address 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 FirstMulticastAddress member of the IP_ADAPTER_ADDRESSES structure is a pointer to a linked list of IP_ADAPTER_MULTICAST_ADDRESS structures.

The SOCKET_ADDRESS structure is used in the IP_ADAPTER_MULTICAST_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_MULTICAST_ADDRESS structure, the Winsock2.h header file must be included before the Iphlpapi.h header file.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header iptypes.h (include Iphlpapi.h)

See also

GetAdaptersAddresses

IP Helper Start Page

IP Helper Structures

IP_ADAPTER_ADDRESSES

SOCKET_ADDRESS