IP_ADAPTER_UNICAST_ADDRESS (Compact 7)

  • Article

3/12/2014

This structure stores a single unicast IP address in a linked list of IP addresses for a particular adapter.

Syntax

typedef struct _IP_ADAPTER_UNICAST_ADDRESS {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Flags;
    }
  };
  struct _IP_ADAPTER_UNICAST_ADDRESS* Next;
  SOCKET_ADDRESS Address;
  IP_PREFIX_ORIGIN PrefixOrigin;
  IP_SUFFIX_ORIGIN SuffixOrigin;
  IP_DAD_STATE DadState;
  ULONG ValidLifetime;
  ULONG PreferredLifetime;
  ULONG LeaseLifetime;
} IP_ADAPTER_UNICAST_ADDRESS*, PIP_ADAPTER_UNICAST_ADDRESS;

Members

  • Length
    The length of this structure.

  • Flags
    Flags for this address. The following table shows the possible values. These constants are defined in the Iptypes.h header file.

    Value Description

    IP_ADAPTER_ADDRESS_DNS_ELIGIBLE

    The address is eligible to appear in DNS.

    IP_ADAPTER_ADDRESS_TRANSIENT

    The address is a cluster address and should not be used by most applications.
  • Next
    Pointer to the next adapter address structure in the list.
  • Address
    The IP address for this unicast IP address entry. This member can be an IPv6 address or an IPv4 address.
  • PrefixOrigin
    The prefix or network part of IP the address. This member can be one of the values from the IP_PREFIX_ORIGIN enumeration type that is defined in the Iptypes.h header file.
  • SuffixOrigin
    The suffix or host part of the IP address. This member can be one of the values from the IP_SUFFIX_ORIGIN enumeration type that is defined in the Iptypes.h header file.
  • DadState
    The duplicate address detection (DAD) state. This member can be one of the values from the IP_DAD_STATE enumeration type that is defined in the Iptypes.h header file. Duplicate address detection is available for both IPv4 and IPv6 addresses.
  • ValidLifetime
    The maximum lifetime, in seconds, that the IP address is valid. A value of 0xffffffff is considered infinite.
  • PreferredLifetime
    The preferred lifetime, in seconds, that the IP address is valid. A value of 0xffffffff is considered infinite.
  • LeaseLifetime
    The lease lifetime, in seconds, that the IP address is valid.

Remarks

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

Requirements

Header

iptypes.h

See Also

Reference

IP Helper Structures
IP_DAD_STATE
IP_PREFIX_ORIGIN
IP_SUFFIX_ORIGIN
GetAdaptersAddresses
IP_ADAPTER_ADDRESSES
SOCKET_ADDRESS