SetupDiGetHwProfileList 関数 (setupapi.h)

  • [アーティクル]

SetupDiGetHwProfileList 関数は、現在定義されているすべてのハードウェア プロファイル ID の一覧を取得します。

構文

WINSETUPAPI BOOL SetupDiGetHwProfileList(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex
);

パラメーター

[out] HwProfileList

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

[in] HwProfileListSize

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

[out] RequiredSize

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

[out, optional] CurrentlyActiveIndex

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

戻り値

成功した場合、関数は TRUE を 返します。 それ以外の場合は FALSE を 返し、 GetLastError を呼び出すことでログに記録されたエラーを取得できます。

注釈

SetupDiGetHwProfileListEx を呼び出して、リモート コンピューターのハードウェア プロファイル ID を取得します。

要件

要件 値
サポートされている最小のクライアント Microsoft Windows 2000 以降のバージョンの Windows で使用できます。
対象プラットフォーム デスクトップ
Header setupapi.h (Setupapi.h を含む)
Library Setupapi.lib
[DLL] Setupapi.dll

こちらもご覧ください

SetupDiCreateDevRegKey

SetupDiOpenDevRegKey