[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 RTM_IP_ROUTE structure contains information that describes a route owned by the IP protocol family.
Syntax
typedef struct _RTM_IP_ROUTE {
FILETIME RR_TimeStamp;
DWORD RR_RoutingProtocol;
DWORD RR_InterfaceID;
PROTOCOL_SPECIFIC_DATA RR_ProtocolSpecificData;
IP_NETWORK RR_Network;
IP_NEXT_HOP_ADDRESS RR_NextHopAddress;
IP_SPECIFIC_DATA RR_FamilySpecificData;
} RTM_IP_ROUTE, *PRTM_IP_ROUTE;
Members
RR_TimeStamp
Specifies the time that the route entry was created or last updated. This member is set by the routing table manager. The time is expressed as a FILETIME structure.
RR_RoutingProtocol
Specifies the routing protocol that added the route.
RR_InterfaceID
Specifies the interface through which the route was obtained.
RR_ProtocolSpecificData
Specifies a PROTOCOL_SPECIFIC_DATA structure that contains memory reserved for routing-protocol-specific data.
RR_Network
Specifies an IP_NETWORK structure that contains an IP network address.
RR_NextHopAddress
Specifies an IP_NEXT_HOP_ADDRESS structure that contains the address of the next-hop router.
RR_FamilySpecificData
Specifies an IP_SPECIFIC_DATA structure that contains IP protocol-family-specific data.
Remarks
The members of the RTM_IP_ROUTE structure are all DWORD aligned.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| End of server support | Windows Server 2003 |
| Header | Rtm.h |
See also
Routing Table Manager Version 1 Reference
Routing Table Manager Version 1 Structures
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
