setIpForwardEntry2 函数 (netioapi.h)

项目
02/29/2024

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

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API SetIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Route
);

参数

[in] Route

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

返回值

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

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

返回代码	说明
ERROR_ACCESS_DENIED	访问被拒绝。此错误在以下几种情况下返回：用户在本地计算机上缺少所需的管理权限，或者应用程序没有作为内置管理员 (RunAs 管理员) 在增强的 shell 中运行。
ERROR_INVALID_PARAMETER	向该函数传递了无效参数。如果在 Route 参数中传递了 NULL 指针，未指定 Route 参数指向的MIB_IPFORWARD_ROW2的 DestinationPrefix 成员，未指定 Route 参数指向的MIB_IPFORWARD_ROW2的 NextHop 成员，或者路由参数指向MIB_IPFORWARD_ROW2的 InterfaceLuid 或 InterfaceIndex 成员，则返回此错误参数未指定。
ERROR_NOT_FOUND	找不到指定的接口。如果找不到 Route 参数指向的MIB_IPFORWARD_ROW2的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口，则返回此错误。
其他	使用 FormatMessage 获取返回错误的消息字符串。

注解

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

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

Route 参数指向的 MIB_IPFORWARD_ROW2 结构中的 DestinationPrefix 成员必须初始化为有效的 IP 地址前缀和系列。 Route 参数指向的 MIB_IPFORWARD_ROW2 结构中的 NextHop 成员必须初始化为有效的 IP 地址和系列。此外，必须将指向 Route 参数的 MIB_IPFORWARD_ROW2 结构中的以下成员中的至少一个初始化为接口：InterfaceLuid 或 InterfaceIndex。

字段按上面列出的顺序使用。因此，如果指定 了 InterfaceLuid ，则此成员用于确定要添加单播 IP 地址的接口。如果没有为 InterfaceLuid 成员设置值， (此成员的值) 设置为零，则接下来使用 InterfaceIndex 成员来确定接口。

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

调用 SetIpForwardEntry2 函数时，将忽略行指向的MIB_IPFORWARD_ROW2结构的 Age 和 Origin 成员。这些成员由网络堆栈设置，不能使用 SetIpForwardEntry2 函数进行更改。

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

SetIpForwardEntry2 函数只能由以管理员组成员身份登录的用户调用。如果 SetIpForwardEntry2 由不是 Administrators 组成员的用户调用，则函数调用将失败并返回 ERROR_ACCESS_DENIED 。

SetIpForwardEntry2 函数也可能因为用户帐户控制 (Windows Vista 及更高版本上的 UAC) 而失败。如果包含此函数的应用程序由以管理员组成员身份登录（而非内置管理员）的用户执行，则此调用将失败，除非应用程序已在清单文件中标记为 requestedExecutionLevel 设置为 requireAdministrator。如果应用程序缺少此清单文件，则作为管理员组成员（而非内置管理员）登录的用户必须在增强的 shell 中执行应用程序，因为内置管理员 (RunAs 管理员) 才能使此功能成功。

要求

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