IP_SPECIFIC_DATA structure

[This API has been superseded by the Routing Table Manager Version 2 API and will not be available beyond Windows Server 2003. Applications should use the Routing Table Manager Version 2 API.]

The IP_SPECIFIC DATA structure contains IP-specific data.

Syntax

typedef struct _IP_SPECIFIC_DATA {
  DWORD FSD_Type;
  DWORD FSD_Policy;
  DWORD FSD_NextHopAS;
  DWORD FSD_Priority;
  DWORD FSD_Metric;
  DWORD FSD_Metric1;
  DWORD FSD_Metric2;
  DWORD FSD_Metric3;
  DWORD FSD_Metric4;
  DWORD FSD_Metric5;
  DWORD FSD_Flags;
} IP_SPECIFIC_DATA, *PIP_SPECIFIC_DATA;

Members

FSD_Type

Specifies the route type as defined in RFC 1354. The following table shows the possible values for this member.

Member	Meaning
1	The route type is not specified. The type is different from those listed here.
2	The route is invalid. Normally, this value is used to invalidate a route. However, since invalidation is not supported by the routing table manager, the route is still considered in best-route computations. Therefore, routing protocols should not use this value.
3	The route is a local route, that is, the next hop is the final destination.
4	The route is a remote route, that is, the next hop is not the final destination.

FSD_Policy

Specifies the set of conditions that would cause the selection of a multi-path route. This member is typically in IP TOS format. For more information, see RFC 1354.

FSD_NextHopAS

Specifies the autonomous system number of the next hop.

FSD_Priority

Specifies a metric value. The routing table manager uses this value to compare this route entry to route entries obtained from other routing protocols. The value of this member is set by the routing table manager.

FSD_Metric

Specifies a metric value. The routing table manager uses this value to compare this route entry to other route entries obtained from the same routing protocol. The value of this member is set by the routing protocol.

FSD_Metric1

Specifies a routing-protocol-specific metric value. This metric value is documented in RFC 1354.

FSD_Metric2

Specifies a routing-protocol-specific metric value. This metric value is documented in RFC 1354.

FSD_Metric3

Specifies a routing-protocol-specific metric value. This metric value is documented in RFC 1354.

FSD_Metric4

Specifies a routing-protocol-specific metric value. This metric value is documented in RFC 1354.

FSD_Metric5

Specifies a routing-protocol-specific metric value. This metric value is documented in RFC 1354.

FSD_Flags

Specifies whether the route is valid. The routing protocol should first clear these flags, then set the route as either valid or invalid. The routing protocol should use the macros ClearRouteFlags(), SetRouteValid(), and ClearRouteValid() to perform these operations. These macros are defined in Rtm.h.

Remarks

The routing table manager uses the FSD_Priority and FSD_Metric members to compute the best route to a particular destination network.

The FSD_Metric[1-5] members are for MIB II conformance. MIB II agents display only these metric values. They do not display the FSD_Metric metric value. To have the FSD_Metric displayed, the routing protocol should also store the value in one of the FSD_Metric[1-5] members.

The routing table manager does not use the metric values in the FSD_Metric[1-5] members when computing the best route to a destination network. Therefore, the routing protocol should ensure that the FSD_Metric member has an appropriate metric value.

A routing protocol could use the FSD_Flags to mark a route as invalid, if the route should not be used by other routing protocols.

Requirements

See also

Routing Table Manager Version 1 Reference

Routing Table Manager Version 1 Structures

RTM_IP_ROUTE