Share via

GetPerAdapterInfo 関数 (iphlpapi.h)

  • [アーティクル]

GetPerAdapterInfo 関数は、指定したインターフェイスに対応するアダプターに関する情報を取得します。

構文

IPHLPAPI_DLL_LINKAGE DWORD GetPerAdapterInfo(
  [in]  ULONG                IfIndex,
  [out] PIP_PER_ADAPTER_INFO pPerAdapterInfo,
  [in]  PULONG               pOutBufLen
);

パラメーター

[in] IfIndex

インターフェイスのインデックス。 GetPerAdapterInfo 関数は、このインターフェイスに対応するアダプターの情報を取得します。

[out] pPerAdapterInfo

アダプターに関する情報を受け取る IP_PER_ADAPTER_INFO 構造体へのポインター。

[in] pOutBufLen

IP_PER_ADAPTER_INFO構造体のサイズを指定する ULONG 変数へのポインター。 このサイズが情報を保持するのに不十分な場合、 GetPerAdapterInfo はこの変数に必要なサイズを入力し、ERROR_BUFFER_OVERFLOWのエラー コードを返します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

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

リターン コード 説明
ERROR_BUFFER_OVERFLOW
 pOutBufLen パラメーターで示されるバッファー サイズが小さすぎてアダプター情報を保持できません。 pOutBufLen パラメーターは、必要なサイズを指します。
ERROR_INVALID_PARAMETER
 pOutBufLen パラメーターが NULL であるか、呼び出し元プロセスが pOutBufLen が指すメモリに対する読み取り/書き込みアクセス権を持っていないか、呼び出し元プロセスが pAdapterInfo パラメーターによって指すメモリへの書き込みアクセス権を持っていません。
ERROR_NOT_SUPPORTED

GetPerAdapterInfo は、ローカル コンピューターで実行されているオペレーティング システムではサポートされていません。
その他
 関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。
 
 

注釈

アダプターのインデックスは、アダプターを無効にしてから有効にした場合、またはその他の状況で変更される可能性があり、永続的と見なすべきではありません。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー iphlpapi.h
Library Iphlpapi.lib
[DLL] Iphlpapi.dll

こちらもご覧ください

IP ヘルパー関数リファレンス

IP ヘルパーの開始ページ

IP_PER_ADAPTER_INFO