共用方式為


FlushIpPathTable 函式

FlushIpPathTable 函式會排清本機電腦上的 IP 路徑數據表。

語法

NETIOAPI_API FlushIpPathTable(
  _In_ ADDRESS_FAMILY Family
);

參數

  • 家庭 [in]
    要排清的位址系列。

    位址系列可能的值會列在 Winsock2.h 頭檔中。 請注意,AF_位址系列和PF_通訊協定系列常數的值完全相同(例如,AF_INET和PF_INET),因此您可以使用任一常數。

    在 Windows Vista 和更新版本的 Windows作系統上,Ws2def.h 頭文件中定義了 Family 參數的可能值。 請注意,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堆棧,且在 Family 參數中指定了 AF_INET,或者如果本機電腦上沒有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