SetupDiGetHwProfileListExW 関数 (setupapi.h)

  • [アーティクル]

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

構文

WINSETUPAPI BOOL SetupDiGetHwProfileListExW(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCWSTR 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を返します。

解説

Note

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

要件

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

関連項目

SetupDiGetHwProfileFriendlyNameEx