FlushIpPathTable 函数

FlushIpPathTable 函数刷新本地计算机上的 IP 路径表。

语法

NETIOAPI_API FlushIpPathTable(
  _In_ ADDRESS_FAMILY Family
);

参数

  • 家庭 [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 地址表。

返回值

FlushIpPathTable 如果函数成功,则返回STATUS_SUCCESS。

如果函数失败,FlushIpPathTable 返回以下错误代码之一:

返回代码 描述
STATUS_INVALID_PARAMETER

将无效参数传递给函数。 如果未将 Family 参数指定为 AF_INET、AF_INET6 或 AF_UNSPEC,则返回此错误。

STATUS_NOT_SUPPORTED

不支持该请求。 如果没有 IPv4 堆栈位于本地计算机上,并且AF_INET已在 Family 参数中指定,或者没有 IPv6 堆栈位于本地计算机上,并且AF_INET6是在 Family 参数中指定的,则返回此错误。 在不支持此函数的 Windows 版本上也返回此错误。

其他

使用 FormatMessage 函数获取返回的错误的消息字符串。

言论

FlushIpPathTable 函数刷新或删除本地计算机上的 IP 路径条目。 驱动程序可以使用 Family 参数来限制要删除到特定 IP 地址系列的 IP 路径条目。 如果应删除 IPv4 和 IPv6 的 IP 路径条目,驱动程序应将 Family 参数设置为AF_UNSPEC。

驱动程序必须将 Family 参数初始化为AF_INET、AF_INET6或AF_UNSPEC。

要求

目标平台

通用

版本

在 Windows Vista 和更高版本的 Windows作系统中可用。

页眉

Netioapi.h (包括 Netioapi.h)

图书馆

Netio.lib

IRQL

< DISPATCH_LEVEL

另请参阅

GetIpPathEntry

GetIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE