flushIpNetTable2 函数 (netioapi.h)

项目
03/05/2024

FlushIpNetTable2 函数刷新本地计算机上的 IP 邻居表。

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API FlushIpNetTable2(
  [in] ADDRESS_FAMILY Family,
  [in] NET_IFINDEX    InterfaceIndex
);

参数

[in] Family

要刷新的地址系列。

Winsock2.h 头文件中列出了地址系列的可能值。请注意，AF_地址系列和PF_协议系列常量的值 (相同，例如 ，AF_INET 和 PF_INET) ，因此可以使用任一常量。

在为 Windows Vista 及更高版本发布的Windows SDK上，头文件的组织已更改，Ws2def.h 头文件中定义了此成员的可能值。请注意， Ws2def.h 头文件自动包含在 Winsock2.h 中，不应直接使用。

当前支持的值是 AF_INET、 AF_INET6和 AF_UNSPEC。

值	含义
AF_UNSPEC 0	未指定地址系列。指定此参数后，此函数将刷新包含 IPv4 和 IPv6 条目的邻居 IP 地址表。
AF_INET 2	Internet 协议版本 4 (IPv4) 地址系列。指定此参数后，此函数将刷新仅包含 IPv4 条目的邻居 IP 地址表。
AF_INET6 23	Internet 协议版本 6 (IPv6) 地址系列。指定此参数后，此函数将刷新仅包含 IPv6 条目的邻居 IP 地址表。

[in] InterfaceIndex

接口索引。如果指定了索引，请刷新特定接口上的相邻 IP 地址条目，否则刷新所有接口上的相邻 IP 地址条目。若要忽略接口，请将此参数设置为零。

返回值

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

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

返回代码	说明
ERROR_ACCESS_DENIED	访问被拒绝。此错误在以下几种情况下返回：用户在本地计算机上缺少所需的管理权限，或者应用程序未在增强的 shell 中运行，因为内置的管理员 (RunAs 管理员) 。
ERROR_INVALID_PARAMETER	向该函数传递了无效参数。如果未将 Family 参数指定为 AF_INET、 AF_INET6或 AF_UNSPEC，则返回此错误。
ERROR_NOT_SUPPORTED	不支持该请求。如果本地计算机上没有 IPv4 堆栈，并且 Family 参数中指定了AF_INET，则返回此错误。如果本地计算机上没有 IPv6 堆栈，并且 Family 参数中指定了AF_INET6，也会返回此错误。在不支持此函数的 Windows 版本上也会返回此错误。
其他	使用 FormatMessage 获取返回错误的消息字符串。

注解

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

The
FlushIpNetTable2 函数刷新或删除本地系统上的相邻 IP 地址。 Family 参数可用于将要删除的邻居 IP 地址限制为特定的 IP 地址系列。如果应删除 IPv4 和 IPv6 的邻居 IP 地址，请将 Family 参数设置为 AF_UNSPEC。 InterfaceIndex 参数可用于将要删除的邻居 IP 地址限制为特定接口。如果应删除所有接口的邻居 IP 地址，请将 InterfaceIndex 参数设置为零。

Family 参数必须初始化为AF_INET、AF_INET6或AF_UNSPEC。

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

要求

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