SetupDiGetClassImageListExA 関数 (setupapi.h)

  • [アーティクル]

SetupDiGetClassImageListEx 関数は、ローカル システムまたはリモート システムにインストールされているすべてのクラスのビットマップのイメージ リストを作成します。

構文

WINSETUPAPI BOOL SetupDiGetClassImageListExA(
  [out]          PSP_CLASSIMAGELIST_DATA ClassImageListData,
  [in, optional] PCSTR                   MachineName,
                 PVOID                   Reserved
);

パラメーター

[out] ClassImageListData

イメージ リストへの ハンドルなど、 クラスイメージリストに関する情報を受け取るSP_CLASSIMAGELIST_DATA構造体へのポインター。 この構造体の cbSize フィールドは、この関数を呼び出す前に、構造体のサイズ (バイト単位) で初期化する必要があります。または、失敗します。

[in, optional] MachineName

クラス SetupDiGetClassImageListEx がビットマップをビルドする必要があるリモート システムの名前を提供する NULL で終わる文字列へのポインター。 このパラメーターは省略可能であり、 NULL にすることができます。 MachineName が NULL の場合、SetupDiGetClassImageListEx はローカル システムのリストをビルドします。

注意事項

この機能は削除されたため、この関数を使用してリモート マシンにアクセスすることは、Windows 8とWindows Server 2012以降はサポートされていません。

Reserved

NULL にする必要があります。

戻り値

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

注釈

この関数によってビルドされたイメージ リストは、 SetupDiDestroyClassImageList を呼び出して破棄する必要があります。

メモ リモート コンピューター上のクラス固有のアイコンは、クラスがローカル コンピューターにも存在する場合にのみ表示できます。 したがって、リモート コンピューターにクラス X があり、クラス X がローカルにインストールされていない場合は、汎用 (不明) アイコンが返されます。
 

注意

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

要件

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

こちらもご覧ください

SetupDiDestroyClassImageList

SetupDiGetClassImageList