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	因特網通訊協定第 4 版 (IPv4) 位址系列。指定此參數時，此函式會排清只包含IPv4項目的鄰近IP位址表。
AF_INET6 23	因特網通訊協定第 6 版 (IPv6) 位址系列。指定此參數時，此函式會排清只包含IPv6項目的鄰近IP位址表。

[in] InterfaceIndex

介面索引。如果指定索引，請排清特定介面上的鄰近IP位址專案，否則清除所有介面上的鄰近IP位址專案。若要忽略介面，請將此參數設定為零。

傳回值

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

傳回碼	Description
ERROR_ACCESS_DENIED	存取遭到拒絕。此錯誤會在數種狀況下傳回：使用者缺少本機電腦上的必要系統管理許可權，或應用程式未在增強殼層中執行，因為內建系統管理員 (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，否則此呼叫將會失敗。如果應用程式缺少此指令清單檔，則身為系統管理員以外的 Administrators 群組成員登入的使用者，就必須在增強殼層中執行應用程式，因為內建系統管理員 (RunAs 系統管理員) ，此函式才能成功。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	netioapi.h (包括 Iphlpapi.h)
程式庫	Iphlpapi.lib
Dll	Iphlpapi.dll