[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 RtmIsRoute function determines if one or more routes to a specified destination network exist. If so, the function returns information for the best route to that network.
Syntax
BOOL RtmIsRoute(
_In_ DWORD ProtocolFamily,
_In_ PVOID Network,
_Out_ PVOID BestRoute
);
Parameters
ProtocolFamily [in]
Specifies the type of data structure pointed to by the Network parameter, for example, IP_NETWORK, IPX_NETWORK.
Network [in]
Pointer to a structure that specifies protocol-family-specific network number data. This data identifies the network for which the caller seeks route information.
BestRoute [out]
Pointer to a protocol-family-specific structure that receives the current best route information, if any.
Return value
The return value is one of the following codes.
| Value | Description |
|---|---|
| TRUE | At least one route to the specified network exists. The best route is returned in the structure pointed to by the BestRoute parameter. |
| FALSE | There is no route to the specified network, or the operation failed. Call GetLastError to obtain more information: |
| NO_ERROR | The operation succeeded, but there is no route to the specified network. |
| ERROR_INVALID_PARAMETER | The value of the ProtocolFamily parameter does not correspond to any installed protocol family. |
| ERROR_NO_SYSTEM_RESOURCES | There are insufficient resources to carry out the operation. |
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 |
| Library | Rtm.lib |
| DLL | Rtm.dll |
See also
Routing Table Manager Version 1 Reference
Routing Table Manager Version 1 Functions
RTMv1 Protocol Family Identifiers
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.
