GetIpForwardEntry2 函数

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

语法

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

参数

  • [in, out]
    指向 IP 路由条目 MIB_IPFORWARD_ROW2 结构条目的指针。 成功返回后,此结构将更新 IP 路由条目的属性。

返回值

如果函数成功,GetIpForwardEntry2 将返回STATUS_SUCCESS。

如果函数失败, GetIpForwardEntry2 将返回以下错误代码之一:

返回代码 说明
STATUS_INVALID_PARAMETER

向该函数传递了无效参数。 如果发生以下情况之一,则返回此错误:

  • 在 Row 参数中传递 NULL 指针。

  • 未指定 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员。

  • 未指定 MIB_IPFORWARD_ROW2 结构的 NextHop 成员。

  • 未指定 MIB_IPFORWARD_ROW2 结构的 InterfaceLuidInterfaceIndex 成员。

  • MIB_IPFORWARD_ROW2 结构的 PreferredLifetime 成员大于 ValidLifetime 成员。

  • MIB_IPFORWARD_ROW2 结构的 SitePrefixLength 成员大于 DestinationPrefix 成员指定的前缀长度。

STATUS_NOT_FOUND

找不到指定的接口。 如果函数找不到 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 InterfaceLuidInterfaceIndex 成员指定的网络接口,则返回此错误。

STATUS_NOT_SUPPORTED

不支持该请求。 如果本地计算机上没有 IPv4 堆栈,并且行参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员的地址系列中指定了AF_INET,或者本地计算机上没有 IPv6 堆栈,并且为 DestinationPrefix 成员中的地址系列指定了AF_INET6,则返回此错误。

其他

使用 FormatMessage 函数获取返回错误的消息字符串。

注解

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

输入时,驱动程序必须初始化 Row 参数指向的MIB_IPFORWARD_ROW2结构的以下成员。

  • DestinationPrefix
    设置为有效的 IPv4 或 IPv6 地址前缀和系列。

  • NextHop
    设置为有效的 IPv4 或 IPv6 地址和系列。

  • InterfaceLuidInterfaceIndex
    这些成员按前面列出的顺序使用。 因此,如果指定 了 InterfaceLuid ,则此成员用于确定接口。 如果没有为 InterfaceLuid 成员设置值 (此成员的值设置为零) ,则接下来使用 InterfaceIndex 成员来确定接口。

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

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

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

要求

目标平台

通用

版本

在 Windows Vista 和更高版本的 Windows 操作系统中可用。

标头

Netioapi.h (包括 Netioapi.h)

Netio.lib

IRQL

< DISPATCH_LEVEL

另请参阅

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetBestRoute2

GetIpForwardTable2

GetIpInterfaceEntry

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2

SetIpForwardEntry2