GetIfEntry2Ex 関数 (netioapi.h)

[アーティクル]
08/25/2023

GetIfEntry2Ex 関数は、ローカルコンピューター上の指定したインターフェイスの指定されたレベルの情報を取得します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIfEntry2Ex(
  [in]      MIB_IF_ENTRY_LEVEL Level,
  [in, out] PMIB_IF_ROW2       Row
);

パラメーター

[in] Level

取得するインターフェイス情報のレベル。このパラメーターには、Netioapi.h ヘッダーファイルで定義されているMIB_IF_ENTRY_LEVEL列挙型の値のいずれかを指定できます。

値	意味
MibIfEntryNormal 0	Row パラメーターが指すMIB_IF_ROW2構造体のメンバーで返される統計と状態の値は、フィルタースタックの上部から返されます。
MibIfEntryNormalWithoutStatistics 2	Row パラメーターが指すMIB_IF_ROW2構造体のメンバーで返される状態 (統計なし) の値は、フィルタースタックの先頭から返されます。

[in, out] Row

正常に返されると、ローカルコンピューター上のインターフェイスの情報を受け取る、 MIB_IF_ROW2 構造体へのポインター。入力時に、MIB_IF_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーを、情報を取得するインターフェイスに設定する必要があります。

戻り値

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

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

リターンコード	説明
ERROR_FILE_NOT_FOUND	指定されたファイルが見つかりません。 Row パラメーターが指すMIB_IF_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワークインターフェイス LUID またはインターフェイスインデックスがローカルコンピューター上の値ではない場合、このエラーが返されます。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、ROW パラメーターで NULL パラメーターが渡された場合に返されます。 Row パラメーターが指すMIB_IF_ROW2の InterfaceLuid メンバーと InterfaceIndex メンバーの両方が指定されていない場合も、このエラーが返されます。
その他	FormatMessage 関数を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

次に、
GetIfEntry2Ex 関数は、ローカルシステム上の指定されたインターフェイスの情報を取得し、この情報をへのポインターで返します。
MIB_IF_ROW2 構造体。 GetIfEntry2Ex は、取得するインターフェイス情報のレベルを選択できる GetIfEntry2 関数の拡張バージョンです。

入力時に、Row パラメーターで渡されるMIB_IF_ROW2構造体の少なくとも 1 つのメンバーを初期化する必要があります: InterfaceLuid または InterfaceIndex。

フィールドは、上記の順序で使用されます。したがって、 InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。 InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されました)、InterfaceIndex メンバーが次に使用されてインターフェイスが決定されます。

出力時に、Row パラメーターが指すMIB_IF_ROW2構造体の残りのフィールドが入力されます。

Netioapi.h ヘッダーファイルは Iphlpapi.h ヘッダーファイルに自動的に含まれるので、直接使用しないでください。

要件

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