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 地址和系列,并指定 InterfaceLuid 成员或 InterfaceIndex MIB_IPFORWARD_ROW2 成员。
返回值
SetIpForwardEntry2 如果函数成功,则返回STATUS_SUCCESS。
如果函数失败,SetIpForwardEntry2 返回以下错误代码之一:
| 返回代码 | 描述 |
|---|---|
| STATUS_INVALID_PARAMETER | 将无效参数传递给函数。 如果在 Route 参数中传递 NULL 指针,则返回此错误:未指定 Route 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix MIB_IPFORWARD_ROW2 成员,则未指定 NextHop 成员, 或同时 InterfaceLuid 和 InterfaceIndex MIB_IPFORWARD_ROW2 结构的成员均未指定。 |
| STATUS_NOT_FOUND | 找不到指定的接口。 如果函数找不到由 InterfaceLuid 或 InterfaceIndex MIB_IPFORWARD_ROW2 结构的成员指定的网络接口,Route 参数指向的MIB_IPFORWARD_ROW2结构的成员,则返回此错误。 |
| 其他 | 使用 FormatMessage 函数获取返回的错误的消息字符串。 |
言论
SetIpForwardEntry2 函数用于在本地计算机上设置现有 IP 路由条目的属性。
驱动程序必须初始化 行 参数指向的 MIB_IPFORWARD_ROW2 结构的以下成员。
DestinationPrefix
设置为有效的 IPv4 或 IPv6 地址前缀和系列。NextHop
设置为有效的 IPv4 或 IPv6 地址和系列。InterfaceLuid 或 InterfaceIndex
这些成员按前面列出的顺序使用。 因此,如果指定了 InterfaceLuid,则使用此成员来确定接口。 如果未为 InterfaceLuid 成员设置值(此成员的值设置为零),则接下来使用 InterfaceIndex 成员来确定接口。
MIB_IPFORWARD_ROW2结构 指标 成员中指定的路由指标偏移量,Route 参数指向仅表示完整路由指标的一部分。 完整指标是将此路由指标偏移量添加到接口指标的组合,该指标是在关联接口 MIB_IPINTERFACE_ROW 结构的 MIB_IPINTERFACE_ROW 结构 成员中指定的接口指标。 驱动程序可以通过调用 GetIpInterfaceEntry 函数来检索接口指标。
SetIpForwardEntry2 将忽略 Row 参数指向的MIB_IPFORWARD_ROW2结构的 Age 和 Origin 成员。 这些成员由网络堆栈设置,无法使用 SetIpForwardEntry2 函数进行更改。
如果 DestinationPrefix 和 NextHop MIB_IPFORWARD_ROW2结构的成员 Route 参数指向的 ip 路由条目不匹配,则 SetIpForwardEntry2 函数将失败。
要求
目标平台 |
通用 |
版本 |
在 Windows Vista 和更高版本的 Windows作系统中可用。 |
页眉 |
Netioapi.h (包括 Netioapi.h) |
图书馆 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |