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 スタックが存在せず、AF_INETが Family パラメーターで指定された場合、またはローカル コンピューターに IPv6 スタックがなく、ファミリ パラメーターに AF_INET6 が指定されている場合に返されます。 このエラーは、この関数がサポートされていない Windows のバージョンでも返されます。 |
その他の | FormatMessage 関数を使用して、返されたエラーのメッセージ文字列を取得します。 |
備考
FlushIpPathTable 関数は、ローカル コンピューター上の IP パス エントリをフラッシュまたは削除します。 ドライバーは、ファミリ パラメーターを使用して、削除する IP パス エントリを特定の IP アドレス ファミリに制限できます。 IPv4 と IPv6 の両方の IP パス エントリを削除する必要がある場合、ドライバーは Family パラメーターを AF_UNSPEC に設定する必要があります。
ドライバーは、AF_INET、AF_INET6、またはAF_UNSPECに ファミリ パラメーターを初期化する必要があります。
必要条件
ターゲット プラットフォーム |
ユニバーサル |
バージョン |
Windows Vista 以降のバージョンの Windows オペレーティング システムで使用できます。 |
ヘッダ |
Netioapi.h (Netioapi.h を含む) |
図書館 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |
関連項目
GetIpPathTableの