RtmIsRoute

[This is preliminary documentation and subject to change.]

The RtmIsRoute function checks if a route (or routes) to a specified destination network exist. If so, the function returns information for the best route to that network.

BOOL RtmIsRoute(
  DWORD ProtocolFamily,    // specifies type of network
  PVOID Network,           // specifies the network
  PVOID BestRoute          // receives best route for the network
);
 

Parameters

ProtocolFamily

Identifies the type of data structure pointed to by the Network parameter (for example, IP_NETWORK, IPX_NETWORK).

Network

Points to a structure that contains protocol-family-specific network number data. This data identifies the network for which the caller seeks route information.

BestRoute

Points to a protocol-family-specific structure to receive the current best route information (if any).

Return Values

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

No route to the specified network exists, or the operation failed. Call GetLastError to obtain more information:

NO_ERROR

The operation succeeded, but no route exists to the specified network.

ERROR_INVALID_PARAMETER

The value of the ProtocolFamily parameter doesn't correspond to any installed protocol family.

ERROR_NO_SYSTEM_RESOURCES

Insufficient resources to carry out the operation.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in rtm.h.
  Import Library: Link with rtm.lib.

See Also

GetLastError, IP_NETWORK, IPX_NETWORK, RTM Protocol Family Identifiers