CreateIpForwardEntry2 函数

项目
06/14/2023

CreateIpForwardEntry2 函数在本地计算机上创建新的 IP 路由条目。

语法

NETIOAPI_API CreateIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

参数

行 [in]
指向 IP 路由条目 MIB_IPFORWARD_ROW2 结构条目的指针。

返回值

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

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

返回代码	说明
STATUS_INVALID_PARAMETER	向该函数传递了无效参数。如果发生以下情况之一，则返回此错误：在 Row 参数中传递 NULL 指针。未指定 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员。未指定 MIB_IPFORWARD_ROW2 结构的 NextHop 成员。未指定 MIB_IPFORWARD_ROW2 结构的 InterfaceLuid 和 InterfaceIndex 成员。 MIB_IPFORWARD_ROW2 结构的 PreferredLifetime 成员大于 ValidLifetime 成员。 MIB_IPFORWARD_ROW2 结构的 SitePrefixLength 成员大于 DestinationPrefix 成员指定的前缀长度。如果在 Row 参数中传递 NULL 指针，未指定 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员，未指定 MIB_IPFORWARD_ROW2 结构的 NextHop 成员，或者未指定MIB_IPFORWARD_ROW2 结构的 InterfaceLuid 和 InterfaceIndex 成员，则返回此错误。如果在 MIB_IPFORWARD_ROW2 结构中指定的 PreferredLifetime 成员大于 ValidLifetime 成员，或者如果 MIB_IPFORWARD_ROW2 结构中的 SitePrefixLength 大于 DestinationPrefix 成员中指定的前缀长度，则也会返回此错误。
STATUS_NOT_FOUND	找不到指定的接口。如果函数找不到由 Row 参数指向的 MIB_IPNET_ROW2 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口，则返回此错误。
STATUS_NOT_SUPPORTED	不支持该请求。如果指定的接口不支持路由，则返回此错误。如果本地计算机上没有 IPv4 堆栈，并且行参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员的地址系列中指定了AF_INET，或者本地计算机上没有 IPv6 堆栈，并且为 DestinationPrefix 成员中的地址系列指定了AF_INET6，则返回此错误。
ERROR_OBJECT_ALREADY_EXISTS	该对象已经存在。如果 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员是接口上由 MIB_IPFORWARD_ROW2 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的现有 IP 路由条目的副本，则返回此错误。
其他	使用 FormatMessage 函数获取返回错误的消息字符串。

注解

CreateIpForwardEntry2 函数用于在本地计算机上添加新的邻居 IP 地址条目。使用 InitializeIpForwardEntry 函数可以使用默认值初始化 MIB_IPFORWARD_ROW2 结构条目的成员。然后，驱动程序可以更改要修改的MIB_IPFORWARD_ROW2条目中的成员，然后调用 CreateIpForwardEntry2。

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

将 DestinationPrefix 设置为有效的 IPv4 或 IPv6 地址前缀。
将 NextHop 设置为有效的 IPv4 或 IPv6 地址和系列。
将 InterfaceLuid 或 InterfaceIndex 设置为接口的 LUID 或索引值。

InterfaceLuid 和 InterfaceIndex 成员按前面列出的顺序使用。因此，如果指定了 InterfaceLuid ，则此成员用于确定要添加 IP 路由条目的接口。如果没有为 InterfaceLuid 成员设置值 (此成员的值设置为零) ，则接下来使用 InterfaceIndex 成员来确定接口。

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

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

如果 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 和 NextHop 成员是 InterfaceLuid 或 InterfaceIndex 成员中指定的接口上现有 IP 路由条目的副本，则 CreateIpForwardEntry2 函数将失败。

要求

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