FlushIpNetTable2 函数
FlushIpNetTable2 函数刷新本地计算机上的 IP 邻居表。
语法
NETIOAPI_API FlushIpNetTable2(
_In_ ADDRESS_FAMILY Family,
_In_ NET_IFINDEX InterfaceIndex
);
参数
家庭 [in]
要刷新的地址系列。Winsock2.h 头文件中列出了地址系列的可能值。 请注意,AF_地址系列和PF_协议系列常量的值 (相同,例如,AF_INET和PF_INET) ,因此可以使用任一常量。
在 Windows Vista 和更高版本的 Windows 操作系统上, Family 参数的可能值在 Ws2def.h 头文件中定义。 请注意,Ws2def.h 头文件自动包含在 Netioapi.h 中,你不应直接使用 Ws2def.h。
地址系列当前支持以下值:
AF_INET
IPv4 地址系列。 指定此值后,此函数将刷新仅包含 IPv4 条目的邻居 IP 地址表。AF_INET6
IPv6 地址系列。 指定此值后,此函数将刷新仅包含 IPv6 条目的邻居 IP 地址表。AF_UNSPEC
未指定地址系列。 指定此值后,此函数将刷新同时包含 IPv4 和 IPv6 条目的邻居 IP 地址表。
InterfaceIndex [in]
接口索引。 如果指定了索引,该函数将刷新特定接口上的相邻 IP 地址条目。此外,函数会刷新所有接口上的相邻 IP 地址条目。 若要忽略 接口,请将此参数设置为零。
返回值
如果函数成功,FlushIpNetTable2 将返回STATUS_SUCCESS。
如果该函数失败, FlushIpNetTable2 将返回以下错误代码之一:
返回代码 | 说明 |
---|---|
STATUS_INVALID_PARAMETER | 向该函数传递了无效参数。 如果未将 Family 参数指定为AF_INET、AF_INET6或AF_UNSPEC,则返回此错误。 |
STATUS_NOT_SUPPORTED | 不支持该请求。 如果本地计算机上没有 IPv4 堆栈,并且 Family 参数中 指定了AF_INET,或者本地计算机上没有 IPv6 堆栈,并且 Family 参数中 指定了AF_INET6,则返回此错误。 在不支持此函数的 Windows 版本上也会返回此错误。 |
其他 | 使用 FormatMessage 函数获取返回错误的消息字符串。 |
注解
FlushIpNetTable2 函数刷新或删除本地计算机上的相邻 IP 地址。 驱动程序可以使用 Family 参数将要删除的邻居 IP 地址限制为特定的 IP 地址系列。 如果应删除 IPv4 和 IPv6 的邻居 IP 地址,驱动程序应将 Family 参数设置为AF_UNSPEC。 驱动程序可以使用 InterfaceIndex 参数将要删除的相邻 IP 地址限制为特定接口。 如果应删除所有接口的邻居 IP 地址,驱动程序应将 InterfaceIndex 参数设置为零。
驱动程序必须将 Family 参数初始化为AF_INET、AF_INET6或AF_UNSPEC。
要求
目标平台 |
通用 |
版本 |
在 Windows Vista 和更高版本的 Windows 操作系统中可用。 |
标头 |
Netioapi.h (包括 Netioapi.h) |
库 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |