GetBestRoute2 函数

GetBestRoute2 函数检索本地计算机上的 IP 路由条目,以获取到指定目标 IP 地址的最佳路由。

语法

NETIOAPI_API GetBestRoute2(
  _In_opt_       NET_LUID            *InterfaceLuid,
  _In_           NET_IFINDEX         InterfaceIndex,
  _In_opt_ const SOCKADDR_INET       *SourceAddress,
  _In_     const SOCKADDR_INET       *DestinationAddress,
  _In_           ULONG               AddressSortOptions,
  _Out_          PMIB_IPFORWARD_ROW2 BestRoute,
  _Out_          SOCKADDR_INET       *BestSourceAddress
);

参数

  • InterfaceLuid [in, optional]
    本地唯一标识符 (LUID) 指定与 IP 路由条目关联的网络接口。

  • InterfaceIndex [in]
    用于指定与 IP 路由条目关联的网络接口的本地索引值。 当禁用然后启用网络适配器时,或者在其他情况下,此索引值可能会更改,因此此值不会持久保存。

  • SourceAddress [in, optional]
    源 IP 地址。 驱动程序可以省略此参数并传递 NULL 指针。

  • DestinationAddress [in]
    目标 IP 地址。

  • AddressSortOptions [in]
    影响 IP 地址排序方式的一组选项。 当前未使用此参数。

  • BestRoute [out]
    指向 MIB_IPFORWARD_ROW2 结构的指针,用于从源 IP 地址到目标 IP 地址的最佳路由。

  • BestSourceAddress [out]
    指向最佳源 IP 地址的指针。

返回值

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

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

返回代码 说明
STATUS_INVALID_PARAMETER

向该函数传递了无效参数。 如果在 DestinationAddress、BestSourceAddressBestRoute 参数中传递 NULL 指针,则返回此错误。 如果未指定 InterfaceLuidInterfaceIndex 参数,也会返回此错误。 如果 DestinationAddress 参数未指定 IPv4 或 IPv6 地址和系列,也会返回此错误

STATUS_NOT_FOUND

找不到指定的接口。 如果找不到 InterfaceLuidInterfaceIndex 参数指定的网络接口,则返回此错误。

STATUS_NOT_SUPPORTED

不支持该请求。 如果本地计算机上没有 IPv4 堆栈,并且 DestinationAddress 参数中指定了 IPv4 地址和系列,或者本地计算机上没有 IPv6 堆栈,并且 DestinationAddress 参数中指定了 IPv4 地址和系列,则返回此错误。

其他

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

注解

GetBestRoute2 函数用于检索从源 IP 地址到目标 IP 地址的最佳路由的MIB_IPFORWARD_ROW2结构条目。

输入时,驱动程序必须初始化以下参数。

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

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

此外,在输入时,驱动程序可以将 SourceAddress 参数初始化为首选的 IPv4 或 IPv6 地址和系列。

在输出中,当调用成功时, GetBestRoute2 将从源 IP 地址和目标 IP 地址检索最佳路由的MIB_IPFORWARD_ROW2结构。

要求

目标平台

通用

版本

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

标头

Netioapi.h (包括 Netioapi.h)

Netio.lib

IRQL

< DISPATCH_LEVEL

另请参阅

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetIpForwardEntry2

GetIpForwardTable2

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

NotifyRouteChange2

SetIpForwardEntry2