MIB_UNICASTIPADDRESS_ROW (Compact 2013)

  • Article

3/26/2014

Deprecated.

This structure stores information about a unicast IP address.

Syntax

typedef struct _MIB_UNICASTIPADDRESS_ROW {
  SOCKADDR_INET Address;
  NET_LUID InterfaceLuid;
  NET_IFINDEX InterfaceIndex;
  NL_PREFIX_ORIGIN PrefixOrigin;
  NL_SUFFIX_ORIGIN SuffixOrigin;
  ULONG ValidLifetime;
  ULONG PreferredLifetime;
  UINT8 OnLinkPrefixLength;
  BOOLEAN SkipAsSource;
  NL_DAD_STATE DadState;
  SCOPE_ID ScopeId;
  LARGE_INTEGER CreationTimeStamp;
} MIB_UNICASTIPADDRESS_ROW,
  *PMIB_UNICASTIPADDRESS_ROW;

Members

  • Address
    The unicast IP address. This member can be an IPv6 address or an IPv4 address.
  • InterfaceLuid
    The locally unique identifier (LUID) for the network interface associated with this IP address.
  • InterfaceIndex
    The local index value for the network interface associated with this IP address. This index value may change when a network adapter is disabled and then enabled, or under other circumstances, and should not be considered persistent.

  • PrefixOrigin
    The origin of the prefix or network part of IP the address. This member can be one of the values from the NL_PREFIX_ORIGIN enumeration type that is defined in the Nldef.h header file.

    Value

    Meaning

    IpPrefixOriginOther

    0

    The IP address prefix was configured by using a source other than those that are defined in this enumeration. This value applies to an IPv6 or IPv4 address.

    IpPrefixOriginManual

    1

    The IP address prefix was configured manually. This value applies to an IPv6 or IPv4 address.

    IpPrefixOriginWellKnown

    2

    The IP address prefix was configured by using a well-known address. This value applies to an IPv6 link-local address or an IPv6 loopback address.

    IpPrefixOriginDhcp

    3

    The IP address prefix was configured by using DHCP. This value applies to an IPv4 address configured by using DHCP or an IPv6 address configured by using DHCPv6.

    IpPrefixOriginRouterAdvertisement

    4

    The IP address prefix was configured by using router advertisement. This value applies to an anonymous IPv6 address that was generated after it receives a router advertisement.

    IpPrefixOriginUnchanged

    16

    The IP address prefix should be unchanged. This value is used when setting the properties for a unicast IP interface when the value for the IP prefix origin should be unchanged.

  • SuffixOrigin
    The origin of the suffix or host part of IP the address. This member can be one of the values from the NL_SUFFIX_ORIGIN enumeration type that is defined in the Nldef.h header file.

    Value

    Meaning

    IpSuffixOriginOther

    0

    The IP address suffix was configured by using a source other than those that are defined in this enumeration. This value applies to an IPv6 or IPv4 address.

    IpSuffixOriginManual

    1

    The IP address suffix was configured manually. This value applies to an IPv6 or IPv4 address.

    IpSuffixOriginWellKnown

    2

    The IP address suffix was configured by using a well-known address. This value applies to an IPv6 link-local address or an IPv6 loopback address.

    IpSuffixOriginDhcp

    3

    The IP address suffix was configured by using DHCP. This value applies to an IPv4 address configured by using DHCP or an IPv6 address configured by using DHCPv6.

    IpSuffixOriginLinkLayerAddress

    4

    The IP address suffix was the link local address. This value applies to an IPv6 link-local address or an IPv6 address where the network part was generated based on a router advertisement and the host part was based on the MAC hardware address.

    IpSuffixOriginRandom

    5

    The IP address suffix was generated randomly. This value applies to an anonymous IPv6 address where the host part of the address was generated randomly from the MAC hardware address after it receives a router advertisement.

    IpSuffixOriginUnchanged

    16

    The IP address suffix should be unchanged. This value is used when setting the properties for a unicast IP interface when the value for the IP suffix origin should be unchanged.
  • ValidLifetime
    The maximum time, in seconds, that the IP address is valid. A value of 0xffffffff is considered infinite.
  • PreferredLifetime
    The preferred time, in seconds, that the IP address is valid. A value of 0xffffffff is considered infinite.
  • OnLinkPrefixLength
    The length, in bits, of the prefix or network part of the IP address. For a unicast IPv4 address, any value greater than 32 is an illegal value. For a unicast IPv6 address, any value greater than 128 is an illegal value. A value of 255 is commonly used to represent an illegal value.
  • SkipAsSource
    This member specifies if the address can be used as an IP source address.

  • DadState
    The duplicate Address detection (DAD) state. Duplicate address detection applies to both IPv6 and IPv4 addresses. This member can be one of the values from the NL_DAD_STATE enumeration type that is defined in the Nldef.h header file.

    Value

    Meaning

    IpDadStateInvalid

    0

    The DAD state is invalid.

    IpDadStateTentative

    1

    The DAD state is tentative.

    IpDadStateDuplicate

    2

    A duplicate IP address has been detected.

    IpDadStateDeprecated

    3

    The IP address has been deprecated.

    IpDadStatePreferred

    4

    The IP address is the preferred address.
  • ScopeId
    The scope ID of the IP address. This member is applicable only to an IPv6 address. This member cannot be set. It is automatically determined by the interface on which the address was added.
  • CreationTimeStamp
    The time stamp when the IP address was created.

Requirements

Header

ws2def.h,
ws2ipdef.h

See Also

Reference

MIB Structures
CreateUnicastIpAddressEntry
DeleteUnicastIpAddressEntry
GetUnicastIpAddressEntry
GetUnicastIpAddressTable
InitializeUnicastIpAddressEntry
SOCKADDR_INET
MIB_UNICASTIPADDRESS_TABLE
SetUnicastIpAddressEntry
NL_DAD_STATE
NL_PREFIX_ORIGIN
NL_SUFFIX_ORIGIN