次の方法で共有


SetupDiGetHwProfileListExA 関数 (setupapi.h)

SetupDiGetHwProfileListEx 関数は、ローカル コンピューターまたはリモート コンピューターで現在定義されているすべてのハードウェア プロファイル ID の一覧を取得します。

構文

WINSETUPAPI BOOL SetupDiGetHwProfileListExA(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

パラメーター

[out] HwProfileList

現在定義されているハードウェア プロファイル ID の一覧を受け取る配列へのポインター。

[in] HwProfileListSize

HwProfileList バッファー内の DWORD の数。

[out] RequiredSize

現在定義されているハードウェア プロファイルの数を受け取る DWORD 型の変数へのポインター。 数値が HwProfileListSizeより大きい場合、配列のサイズに合わせてリストが切り捨てられます。 requiredSize で返される値は、ハードウェア プロファイルの一覧全体を格納するために必要な配列サイズを示します。

[out, optional] CurrentlyActiveIndex

取得したハードウェア プロファイルの一覧で現在アクティブなハードウェア プロファイルのインデックスを受け取る変数へのポインター。 このパラメーターは省略可能であり、NULLできます。

[in, optional] MachineName

ハードウェア プロファイル ID の一覧を取得するリモート システムの名前を含む NULL で終わる文字列へのポインター。 このパラメーターは省略可能であり、NULLできます。 このパラメーターが NULL場合、ローカル システムのリストが取得されます。

注意

この機能は削除されたため、この機能を使用してリモート コンピューターにアクセスすることは、Windows 8 および Windows Server 2012 以降ではサポートされていません。

Reserved

NULLする必要があります。

戻り値

この関数は、成功した場合 TRUE を返します。 それ以外の場合は、FALSE を返し、GetLastError呼び出すことでログに記録されたエラーを取得できます。 必要なサイズが HwProfileListSizeより大きい場合、SetupDiGetHwProfileListEx は FALSE 返し、GetLastError の呼び出しはERROR_INSUFFICIENT_BUFFERを返します。

備考

手記

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupDiGetHwProfileListEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Microsoft Windows 2000 以降のバージョンの Windows で使用できます。
ターゲット プラットフォーム の デスクトップ
ヘッダー setupapi.h (Setupapi.h を含む)
ライブラリ Setupapi.lib

関連項目

SetupDiGetHwProfileFriendlyNameEx の