GetIfStackTable 関数 (netioapi.h)

[アーティクル]
02/29/2024

GetIfStackTable 関数は、インターフェイススタック上のネットワークインターフェイスのリレーションシップを指定するネットワークインターフェイススタック行エントリのテーブルを取得します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIfStackTable(
  [out] PMIB_IFSTACK_TABLE *Table
);

パラメーター

[out] Table

MIB_IFSTACK_TABLE構造体内のインターフェイススタック行エントリのテーブルを受け取るバッファーへのポインター。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

リターンコード	説明
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、Table パラメーターに NULL ポインターが渡された場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するために使用できるメモリリソースが不足しています。
ERROR_NOT_FOUND	インターフェイススタックエントリが見つかりませんでした。
その他	FormatMessage 関数を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

GetIfStackTable 関数は、Windows Vista 以降で定義されています。

次に、
GetIfStackTable 関数は、ローカルシステム上のインターフェイススタック上の物理ネットワークインターフェイスと論理ネットワークインターフェイスを列挙し、この情報を MIB_IFSTACK_TABLE 構造体で返します。

インターフェイススタックエントリは、Table パラメーターによって指されるバッファー内のMIB_IFSTACK_TABLE構造体で返されます。 MIB_IFSTACK_TABLE構造体には、インターフェイススタックエントリ数と、各インターフェイススタックエントリのMIB_IFSTACK_ROW構造体の配列が含まれています。

インターフェイススタック内のインターフェイス間の関係は、MIB_IFSTACK_ROW 構造体の HigherLayerInterfaceIndex メンバーのインデックスを持つインターフェイスが、MIB_IFSTACK_ROW構造体の LowerLayerInterfaceIndex メンバーのインデックスを持つインターフェイスのすぐ上にあるということです。

メモリは、MIB_IFSTACK_TABLE構造体と、この構造体のMIB_IFSTACK_ROWエントリに対して GetIfStackTable 関数によって割り当てられます。これらの返された構造体が不要になったら、 FreeMibTable を呼び出してメモリを解放します。

Table パラメーターによって示される返されるMIB_IFSTACK_TABLE構造体には、NumEntries メンバーと、MIB_IFSTACK_TABLE構造体の Table メンバー内の最初のMIB_IFSTACK_ROW配列エントリとの間の配置のためのパディングが含まれている場合があることに注意してください。配置のパディングは、 MIB_IFSTACK_ROW 配列エントリ間に存在する場合もあります。 MIB_IFSTACK_ROW配列エントリへのアクセスでは、埋め込みが存在する可能性があると想定する必要があります。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	netioapi.h (Iphlpapi.h を含む)
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll