getIpForwardEntry2 函数 (netioapi.h)

项目
08/25/2023

GetIpForwardEntry2 函数检索本地计算机上的 IP 路由条目的信息。

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardEntry2(
  [in, out] PMIB_IPFORWARD_ROW2 Row
);

参数

[in, out] Row

指向 IP 路由条目 MIB_IPFORWARD_ROW2 结构条目的指针。成功返回后，将使用 IP 路由条目的属性更新此结构。

返回值

如果函数成功，则返回值NO_ERROR。

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

返回代码	说明
ERROR_INVALID_PARAMETER	向该函数传递了无效参数。如果在 Row 参数中传递 NULL 指针，未指定 Row 参数所指向MIB_IPFORWARD_ROW2的 DestinationPrefix 成员、Row 参数指向MIB_IPFORWARD_ROW2的 NextHop 成员，或者 Row 参数指向的 MIB_IPFORWARD_ROW2 InterfaceLuid 或 InterfaceIndex 成员，则返回此错误未指定参数。
ERROR_NOT_FOUND	找不到元素。如果 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口与 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员中指定的 IP 地址前缀和地址系列不匹配，则返回此错误。
ERROR_NOT_SUPPORTED	不支持该请求。如果本地计算机上没有 IPv4 堆栈，并且已在Row 参数指向的 MIB_IPFORWARD_ROW2的 DestinationPrefix 成员的地址系列中指定了AF_INET，则返回此错误。如果本地计算机上没有 IPv6 堆栈，并且为 DestinationPrefix 成员中的地址系列指定了AF_INET6，也会返回此错误。
其他	使用 FormatMessage 获取返回错误的消息字符串。

注解

GetIpForwardEntry2 函数在 Windows Vista 及更高版本上定义。

GetIpForwardEntry2 函数用于检索MIB_IPFORWARD_ROW2结构条目。

输入时，Row 参数指向的 MIB_IPFORWARD_ROW2 结构中的 DestinationPrefix 成员必须初始化为有效的 IPv4 或 IPv6 地址前缀和系列。输入时，Row 参数指向的 MIB_IPFORWARD_ROW2 结构中的 NextHop 成员必须初始化为有效的 IPv4 或 IPv6 地址和系列。此外，必须初始化指向 Row 参数的 MIB_IPFORWARD_ROW2 结构中的至少一个成员：InterfaceLuid 或 InterfaceIndex。

字段按上面列出的顺序使用。因此，如果指定了 InterfaceLuid ，则使用此成员来确定接口。如果未为 InterfaceLuid 成员设置值 (此成员的值设置为零) ，则接下来使用 InterfaceIndex 成员来确定接口。

在调用成功时输出时，GetIpForwardEntry2 检索 IP 路由条目的其他属性，并填写 Row 参数指向的MIB_IPFORWARD_ROW2结构。

Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 Metric 成员中指定的路由指标偏移量仅代表整个路由指标的一部分。完整指标是添加到关联接口的 MIB_IPINTERFACE_ROW 结构的Metric 成员中指定的接口指标的路由指标的组合。应用程序可以通过调用 GetIpInterfaceEntry 函数来检索接口指标。

可以调用 GetIpForwardTable2 函数来枚举本地计算机上的 IP 路由条目。

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
目标平台	Windows
标头	netioapi.h (包括 Iphlpapi.h)
Library	Iphlpapi.lib
DLL	Iphlpapi.dll