GetIpInterfaceTable 関数

  • [アーティクル]

GetIpInterfaceTable 関数は、ローカル コンピューター上の IP インターフェイス エントリを取得します。

構文

NETIOAPI_API GetIpInterfaceTable(
  _In_  ADDRESS_FAMILY         Family,
  _Out_ PMIB_IPINTERFACE_TABLE *Table
);

パラメーター

  • ファミリ [in]
    取得する IP インターフェイスのアドレス ファミリ。

    アドレス ファミリに使用できる値は、Winsock2.h ヘッダー ファイルに一覧表示されます。 AF_ アドレス ファミリ定数と PF_ プロトコル ファミリ定数の値は同じ (たとえば、AF_INET と PF_INET) なので、どちらの定数も使用できます。

    Windows Vista 以降のバージョンの Windows オペレーティング システムでは、Family パラメーターに使用できる値は Ws2def.h ヘッダー ファイルで定義されています。 Ws2def.h ヘッダー ファイルは Netioapi.h に自動的に含まれるので、Ws2def.h を直接使用しないでください。

    現在、アドレス ファミリでは次の値がサポートされています:

    • AF_INET
      IPv4 アドレス ファミリ。

    • AF_INET6
      IPv6 アドレス ファミリ。

    • AF_UNSPEC
      アドレス ファミリは指定されていません。 この値を指定すると、GetIpInterfaceTable 関数は、IPv4 エントリと IPv6 エントリの両方を含む IP インターフェイス テーブルを返します。

  • テーブル [out]
    MIB_IPINTERFACE_TABLE 構造体の IP インターフェイス エントリのテーブルを受け取るバッファーへのポインター。

戻り値

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

関数が失敗した場合、GetIpInterfaceTable は次のいずれかのエラー コードを返します:

リターン コード 説明
STATUS_INVALID_PARAMETER

その関数に渡された無効なパラメーター。 このエラーは、Table パラメーターに NULL ポインターが渡された場合、または Family パラメーターが AF_INET、AF_INET6、または AF_UNSPEC として指定されていない場合に返されます。
STATUS_NOT_ENOUGH_MEMORY

操作を完了するために使用できるメモリ リソースが不足しています。
STATUS_NOT_FOUND

Family パラメーターで指定されている IP インターフェイス エントリが見つかりませんでした。
STATUS_NOT_SUPPORTED

関数はサポートされません。 このエラーは、Address パラメーターで指定された IP トランスポートがローカル コンピューター上で構成されていない場合に返されます。 このエラーは、この関数がサポートされていない Windows のバージョンでも返されます。
その他

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

解説

GetIpInterfaceTable 関数は、ローカル コンピューター上の IP インターフェイスを列挙し、この情報を MIB_IPINTERFACE_TABLE 構造体で返します。

GetIpInterfaceTable は Table パラメーターが指すバッファー内の MIB_IPINTERFACE_TABLE 構造体の IP インターフェイス エントリを返します。 MIB_IPINTERFACE_TABLE 構造体には、IP インターフェイス エントリ数と、各 IP インターフェイス エントリに対応する MIB_IPINTERFACE_ROW 構造体の配列が含まれています。 これらの返された構造体が不要になった場合、ドライバーはその FreeMibTable 関数を呼び出してメモリを解放する必要があります。

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

Table パラメーターが指す返された MIB_IPINTERFACE_TABLE 構造体には、NumEntries メンバーと MIB_IPINTERFACE_TABLE 構造体の Table メンバーの最初の MIB_IPINTERFACE_ROW 配列エントリとの間に、整列のためのパディングが含まれている可能性があることに注意してください。 整列のためのパディングは、MIB_IPINTERFACE_ROW 配列エントリ間にも存在する場合があります。 MIB_IPINTERFACE_ROW 配列エントリへのアクセスには、パディングが存在する可能性があることを前提とするべきです。

要件

対象プラットフォーム

 ユニバーサル

バージョン

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

ヘッダー

 Netioapi.h (Netioapi.h を含む)

ライブラリ

 Netio.lib

IRQL

< DISPATCH_LEVEL

関連項目

FreeMibTable

MIB_IPINTERFACE_ROW

MIB_IPINTERFACE_TABLE

MIB_IPNET_ROW2

MIB_IPNET_TABLE2