RtmGetNextRoute 函数

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

RtmGetNextRoute 函数从表中的指定路由子集返回下一个路由。

语法

DWORD RtmGetNextRoute(
  _In_    DWORD ProtocolFamily,
  _In_    DWORD EnumerationFlags,
  _Inout_ PVOID Route
);

parameters

ProtocolFamily [in]

指定要检索的路由的协议系列,例如 IP 或 IPX。

EnumerationFlags [in]

指定应枚举的路由。 此参数将已删除的路由集限制为由以下标志定义的子集,以及 CriteriaRoute 参数指向的结构的相应成员中的值。 标志与 RtmCreateEnumerationHandle 中使用的标志相同。

路由 [in, out]

输入时, 路由 指向协议系列特定的结构, ( RTM_IP_ROUTERTM_IPX_ROUTE) 。

调用函数为此结构提供成员值。 这些值与 EnumerationFlags 参数一起指定从中返回路由的集。

在输出中, Route 指向一个结构,该结构接收与指定条件匹配的第一个路由。

返回值

如果函数成功,则返回值 NO_ERROR

如果函数失败,则返回值为以下错误代码之一。

说明
ERROR_INVALID_PARAMETER
其中一个参数无效。
ERROR_NO_ROUTES
没有与指定条件匹配的路由。
ERROR_NO_SYSTEM_RESOURCES
资源不足,无法执行该操作。

备注

路由按以下顺序返回:

  1. 网络号码
  2. 路由协议
  3. 接口标识符
  4. 下一跃点地址

此函数的效率低于相应的枚举句柄函数。

要求

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

Rtm.lib
DLL
Rtm.dll

另请参阅

路由表管理器版本 1 参考

路由表管理器版本 1 函数

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetFirstRoute