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 堆疊,而且在 Family 參數中指定了AF_INET,或者沒有 IPv6 堆疊位於本機電腦上,而且已在 Family 參數中指定AF_INET6,就會傳回此錯誤。 這個錯誤也會在不支援此函式的 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 |