DeleteIpForwardEntry2 函数

项目
06/15/2023

DeleteIpForwardEntry2 函数删除本地计算机上的 IP 路由条目。

语法

NETIOAPI_API DeleteIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

参数

行 [in]
指向 IP 路由条目 MIB_IPFORWARD_ROW2 结构条目的指针。成功返回后，将删除此条目。

返回值

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

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

返回代码	说明
STATUS_INVALID_PARAMETER	向该函数传递了无效参数。如果在 Row 参数中传递 NULL 指针，未指定 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 成员、未指定 MIB_IPFORWARD_ROW2 结构的 NextHop 成员，或者未指定 MIB_IPFORWARD_ROW2 结构的 InterfaceLuid 和 InterfaceIndex 成员，则返回此错误。
STATUS_NOT_FOUND	找不到指定的接口。如果函数找不到 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口，则返回此错误。
STATUS_NOT_SUPPORTED	不支持该请求。如果本地计算机上没有 IPv4 堆栈，并且 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 Address 成员中指定了 IPv4 地址，或者本地计算机上没有 IPv6 堆栈，并且 Address 成员中指定了 IPv6 地址，则返回此错误。
其他	使用 FormatMessage 函数获取返回错误的消息字符串。

注解

DeleteIpForwardEntry2 函数用于删除MIB_IPFORWARD_ROW2结构条目。

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

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

在输出中，当调用成功时， DeleteIpForwardEntry2 将删除 IP 路由条目。

如果 Row 参数指向的 MIB_IPFORWARD_ROW2 结构的 DestinationPrefix 和 NextHop 成员与 InterfaceLuid 或 InterfaceIndex 成员中指定的接口上的现有 IP 路由条目不匹配，DeleteIpForwardEntry2 函数将失败。

驱动程序可以调用 GetIpForwardTable2 函数来枚举本地计算机上的 IP 路由条目。

要求

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