次の方法で共有

FlushIpNetTable2 関数

  • [アーティクル]

FlushIpNetTable2 関数は、ローカル コンピューター上の IP 近隣テーブルをフラッシュします。

構文

NETIOAPI_API FlushIpNetTable2(
  _In_ ADDRESS_FAMILY Family,
  _In_ NET_IFINDEX    InterfaceIndex
);

パラメーター

  • ファミリ [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 アドレス テーブルをフラッシュします。

  • InterfaceIndex [in]
    インターフェイス インデックス。 インデックスが指定されている場合、関数は特定のインターフェイスで近隣 IP アドレス エントリをフラッシュします。それ以外では、関数はすべてのインターフェイスで近隣 IP アドレス エントリをフラッシュします。 インターフェイスを無視するには、このパラメーターを 0 に設定してください。

戻り値

関数が成功した場合、FlushIpNetTable2 は STATUS_SUCCESS を返します。

関数が失敗した場合、FlushIpNetTable2 は以下のエラーコードの 1 つを返します。

リターン コード 説明
STATUS_INVALID_PARAMETER

その関数に無効なパラメーターが渡された。 Family パラメーターが AF_INET、AF_INET6、でもAF_UNSPEC でもなかった場合、このエラーが特定されます。
STATUS_NOT_SUPPORTED

要求はサポートされていません。 このエラーは、IPv4 スタックがローカル コンピューターに存在せず、AF_INET が Family パラメーターで指定された場合、またはローカル コンピューターに IPv6 スタックが存在せず、AF_INET6 が Family パラメーターで指定されている場合に返されます。 このエラーは、この関数がサポートされていない Windows のバージョンでも返されます。
その他

FormatMessage 関数を使用して、返されたエラーのメッセージ文字列を取得します。

解説

FlushIpNetTable2 関数は、ローカル コンピューター上の近隣 IP アドレスのフラッシュまたは削除をします。 ドライバーは Family パラメーターを使用して、近隣 IP アドレスを特定の IP アドレス ファミリに削除するように制限することができます。 IPv4 と IPv6 の両方の近隣 IP アドレスを削除する必要がある場合、ドライバーは Family パラメーターを AF_UNSPEC に設定しなければなりません。 ドライバーは InterfaceIndex パラメーターを使用して、近隣 IP アドレスを特定のインターフェイスに削除するように制限できます。 すべてのインターフェイスの近隣 IP アドレスを削除する必要がある場合、ドライバーは InterfaceIndex パラメーターを 0 に設定してください。

ドライバーは、Family パラメーターを AF_INET、AF_INET6、または AF_UNSPEC のいずれかに初期化する必要があります。

要件

対象プラットフォーム

 ユニバーサル

バージョン

Windows Vista 以降のバージョンの Windows オペレーティング システムで使用できます。

ヘッダー

 Netioapi.h (Netioapi.h を含む)

ライブラリ

 Netio.lib

IRQL

< DISPATCH_LEVEL

関連項目

CreateIpNetEntry2

DeleteIpNetEntry2

GetIpNetEntry2

GetIpNetTable2

MIB_IPNET_ROW2

MIB_IPNET_TABLE2

ResolveIpNetEntry2

SetIpNetEntry2