SetIpForwardEntry2 函数

项目
05/03/2024

SetIpForwardEntry2 函数设置本地计算机上的 IP 路由条目的属性。

语法

NETIOAPI_API SetIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Route
);

参数

路由 [in]
指向 IP 路由条目的MIB_IPFORWARD_ROW2结构条目的指针。驱动程序必须将MIB_IPFORWARD_ROW2结构的 DestinationPrefix 成员设置为有效的 IP 目标前缀和系列，将 MIB_IPFORWARD_ROW2 的 NextHop 成员设置为有效的 IP 地址和系列，并指定 MIB_IPFORWARD_ROW2 的 InterfaceLuid 成员或 InterfaceIndex 成员。

返回值

如果函数成功，SetIpForwardEntry2 将返回STATUS_SUCCESS。

如果函数失败， SetIpForwardEntry2 将返回以下错误代码之一：

返回代码	说明
STATUS_INVALID_PARAMETER	传递给函数的参数无效。如果在 Route 参数中传递 NULL 指针，则返回此错误：未指定 Route 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员、未指定MIB_IPFORWARD_ROW2结构的 NextHop 成员或未指定MIB_IPFORWARD_ROW2结构的 InterfaceLuid 和 InterfaceIndex 成员。
STATUS_NOT_FOUND	无法找到指定的接口。如果函数找不到 Route 参数指向的 MIB_IPFORWARD_ROW2 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口，则返回此错误。
其他	使用 FormatMessage 函数获取返回的错误的消息字符串。

注解

SetIpForwardEntry2 函数用于在本地计算机上设置现有 IP 路由条目的属性。

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

DestinationPrefix
设置为有效的 IPv4 或 IPv6 地址前缀和系列。
NextHop
设置为有效的 IPv4 或 IPv6 地址和系列。
InterfaceLuid 或 InterfaceIndex
这些成员按前面列出的顺序使用。因此，如果指定了 InterfaceLuid，则此成员用于确定接口。如果未为 InterfaceLuid 成员设置任何值（此成员的值设置为零），则接下来使用 InterfaceIndex 成员来确定接口。

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

SetIpForwardEntry2 忽略 Row 参数指向的MIB_IPFORWARD_ROW2结构的 Age 和 Origin 成员。这些成员由网络堆栈设置，无法使用 SetIpForwardEntry2 函数进行更改。

如果 Route 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 和 NextHop 成员与指定接口上的 IP 路由条目不匹配，SetIpForwardEntry2 函数将失败。

要求

目标平台	通用
版本	在 Windows Vista 及更高版本的 Windows 操作系统中可用。
头文件	Netioapi.h（包括 Netioapi.h）
库	Netio.lib
IRQL	< DISPATCH_LEVEL