RtmGetFirstRoute 函数
[此 API 已被 路由表管理器版本 2 API 取代,在 Windows Server 2003 之后不可用。 应用程序应使用路由表管理器版本 2 API。]
RtmGetFirstRoute 函数从表中的指定路由子集返回第一个路由。
语法
DWORD RtmGetFirstRoute(
_In_ DWORD ProtocolFamily,
_In_ DWORD EnumerationFlags,
_Inout_ PVOID Route
);
parameters
-
ProtocolFamily [in]
-
指定要检索的路由的协议系列,例如 IP 或 IPX。
-
EnumerationFlags [in]
-
指定将已删除路由集限制为这些标志定义的子集,以及 CriteriaRoute 参数指向的结构的相应成员中的值。 标志与 RtmCreateEnumerationHandle 中使用的标志相同。
-
路由 [in, out]
-
输入时, 路由 指向协议系列特定的结构, ( RTM_IP_ROUTE 或 RTM_IPX_ROUTE) 。
调用函数为此结构提供成员值。 这些值与 EnumerationFlags 参数一起指定从中返回路由的集。
输出中, Route 指向与指定条件匹配的第一个路由。
返回值
如果函数成功,则返回值NO_ERROR。
如果函数失败,则返回值为以下错误代码之一。
值 | 说明 |
---|---|
|
其中一个参数无效。 |
|
没有与指定条件匹配的路由。 |
|
资源不足,无法执行该操作。 |
备注
路由按以下顺序返回:
- 网络号码
- 路由协议
- 接口标识符
- 下一跃点地址
此函数的效率低于相应的枚举句柄函数 RtmEnumerateGetNextRoute。
要求
要求 | 值 |
---|---|
最低受支持的客户端 |
无受支持的版本 |
最低受支持的服务器 |
Windows 2000 Server [仅限桌面应用] |
终止服务器支持 |
Windows Server 2003 |
标头 |
|
库 |
|
DLL |
|
另请参阅
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈