Edit

MIB_IPPATH_ROW structure (netioapi.h)

  • Article

The MIB_IPPATH_ROW structure stores information about an IP path entry.

Syntax

typedef struct _MIB_IPPATH_ROW {
  SOCKADDR_INET Source;
  SOCKADDR_INET Destination;
  NET_LUID      InterfaceLuid;
  NET_IFINDEX   InterfaceIndex;
  SOCKADDR_INET CurrentNextHop;
  ULONG         PathMtu;
  ULONG         RttMean;
  ULONG         RttDeviation;
  union {
    ULONG LastReachable;
    ULONG LastUnreachable;
  };
  BOOLEAN       IsReachable;
  ULONG64       LinkTransmitSpeed;
  ULONG64       LinkReceiveSpeed;
} MIB_IPPATH_ROW, *PMIB_IPPATH_ROW;

Members

Source

Type: SOCKADDR_INET

The source IP address for this IP path entry.

Destination

Type: SOCKADDR_INET

The destination IP address for this IP path entry.

InterfaceLuid

Type: NET_LUID

The locally unique identifier (LUID) for the network interface associated with this IP path entry.

InterfaceIndex

Type: NET_IFINDEX

The local index value for the network interface associated with this IP path entry. This index value may change when a network adapter is disabled and then enabled, or under other circumstances, and should not be considered persistent.

CurrentNextHop

Type: SOCKADDR_INET

The current IP address of the next system or gateway en route. This member can change over the lifetime of a path.

PathMtu

Type: ULONG

The maximum transmission unit (MTU) size, in bytes, to the destination IP address for this IP path entry.

RttMean

Type: ULONG

The estimated mean round-trip time (RTT), in milliseconds, to the destination IP address for this IP path entry.

RttDeviation

Type: ULONG

The estimated mean deviation for the round-trip time (RTT), in milliseconds, to the destination IP address for this IP path entry.

LastReachable

Type: ULONG

The time, in milliseconds, that a node assumes the destination IP address is reachable after having received a reachability confirmation.

LastUnreachable

Type: ULONG

The time, in milliseconds, that a node assumes the destination IP address is unreachable after not having received a reachability confirmation.

IsReachable

Type: BOOLEAN

A value that indicates if the destination IP address is reachable for this IP path entry.

LinkTransmitSpeed

Type: ULONG64

The estimated speed in bits per second of the transmit link to the destination IP address for this IP path entry.

LinkReceiveSpeed

Type: ULONG64

The estimated speed in bits per second of the receive link from the destination IP address for this IP path entry.

Remarks

The MIB_IPPATH_ROW structure is defined on Windows Vista and later.

The GetIpPathTable function enumerates the IP path entries on a local system and returns this information in a MIB_IPPATH_TABLE structure as an array of MIB_IPPATH_ROW entries.

The GetIpPathEntry function retrieves a single IP path entry and returns this information in a MIB_IPPATH_TABLE structure.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header netioapi.h (include Iphlpapi.h)

See also

FlushIpPathTable

GetIpPathEntry

GetIpPathTable

MIB_IPPATH_TABLE

SOCKADDR_INET