RtmIsRoute 函数

[此 API 已被 路由表管理器版本 2 API 取代,在 Windows Server 2003 之后不可用。 应用程序应使用路由表管理器版本 2 API。]

RtmIsRoute 函数确定是否存在指向指定目标网络的一个或多个路由。 如果是这样,函数将返回到该网络的最佳路由的信息。

语法

BOOL RtmIsRoute(
  _In_  DWORD ProtocolFamily,
  _In_  PVOID Network,
  _Out_ PVOID BestRoute
);

parameters

ProtocolFamily [in]

指定 Network 参数指向的数据结构的类型,例如,IP_NETWORK、IPX_NETWORK

网络 [in]

指向结构的指针,该结构指定特定于协议系列的网络编号数据。 此数据标识调用方为其查找路由信息的网络。

BestRoute [out]

指向协议系列特定的结构的指针,该结构接收当前最佳路由信息(如果有)。

返回值

返回值是以下代码之一。

说明
TRUE
至少存在一个到指定网络的路由。 最佳路由在 BestRoute 参数指向的结构中返回。
FALSE
没有到指定网络的路由,或者操作失败。 调用 GetLastError 以获取详细信息:
NO_ERROR
操作成功,但没有路由到指定网络。
ERROR_INVALID_PARAMETER
ProtocolFamily 参数的值不对应于任何已安装的协议系列。
ERROR_NO_SYSTEM_RESOURCES
资源不足,无法执行该操作。

要求

要求
最低受支持的客户端
无受支持的版本
最低受支持的服务器
Windows 2000 Server [仅限桌面应用]
终止服务器支持
Windows Server 2003
标头
Rtm.h

Rtm.lib
DLL
Rtm.dll

另请参阅

路由表管理器版本 1 参考

路由表管理器版本 1 函数

GetLastError

IP_NETWORK

IPX_NETWORK

RTMv1 协议系列标识符