FlushIpPathTable 函式 (netioapi.h)
FlushIpPathTable 函式會排清本機電腦上的IP路徑數據表。
語法
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API FlushIpPathTable(
[in] ADDRESS_FAMILY Family
);
參數
[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。
傳回值
如果函式成功，傳回值會NO_ERROR。
如果函式失敗，傳回值就是下列其中一個錯誤碼。
| 傳回碼 | Description |
|---|---|
|
存取遭到拒絕。 此錯誤會在下列幾個情況下傳回：使用者缺少本機計算機上的必要系統管理許可權，或應用程式未在增強的殼層中執行，因為 RunAs 系統管理員) 內建系統管理員 (。 |
|
無效的參數已傳遞至 函式。 如果未將 Family 參數指定為 AF_INET、 AF_INET6 或 AF_UNSPEC，則會傳回此錯誤。 |
|
不支援此要求。 如果本機計算機上沒有IPv4堆疊且已在Family參數中指定AF_INET，則會傳回此錯誤。 如果本機計算機上沒有IPv6堆棧，而且已在Family參數中指定AF_INET6，也會傳回此錯誤。 這個錯誤也會在不支援此函式的 Windows 版本上傳回。 |
|
使用 FormatMessage 取得傳回錯誤的訊息字串。 |
備註
FlushIpPathTable 函式是在 Windows Vista 和更新版本上定義。
The
FlushIpPathTable 函式會排清或刪除本機系統上的IP路徑專案。 Family 參數可用來限制IP路徑專案刪除至特定IP位址系列。 如果應該刪除 IPv4 和 IPv6 的 IP 路徑專案，請將 Family 參數設定為 AF_UNSPEC。
Family 參數必須初始化為 AF_INET、AF_INET6 或 AF_UNSPEC。
FlushIpPathTable 函式只能由以 Administrators 群組成員身分登入的使用者呼叫。 如果 FlushIpPathTable 是由不是 Administrators 群組成員的使用者呼叫，則函數調用將會失敗，並 傳回ERROR_ACCESS_DENIED 。 此函式也可能因為 Windows Vista 和更新版本的用戶帳戶控制 (UAC) 而失敗。 如果包含此函式的應用程式是由以內建系統管理員以外的 Administrators 群組成員身分登入的使用者所執行，除非應用程式已在指令清單檔案中標示 為 requestedExecutionLevel 設定為 requireAdministrator，否則此呼叫將會失敗。 如果應用程式缺少此指令清單檔，則以系統管理員以外的 Administrators 群組成員身分登入的使用者，必須在增強的殼層中執行應用程式，因為內建的 Administrator (RunAs 系統管理員) ，此函式才能成功。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
| 目標平台 | Windows |
| 標頭 | netioapi.h (包含 Iphlpapi.h) |
| 程式庫 | Iphlpapi.lib |
| Dll | Iphlpapi.dll |