SetupDiLoadClassIcon 関数 (setupapi.h)
SetupDiLoadClassIcon 関数は、指定したクラスの大きいアイコンとミニ アイコンの両方を読み込みます。
構文
WINSETUPAPI BOOL SetupDiLoadClassIcon(
[in] const GUID *ClassGuid,
[out, optional] HICON *LargeIcon,
[out, optional] PINT MiniIconIndex
);
パラメーター
[in] ClassGuid
アイコンを読み込むクラスの GUID へのポインター。
[out, optional] LargeIcon
指定したクラスの読み込まれた大きなアイコンのハンドル値を受け取るアイコン ハンドルへのポインター。 このポインターは省略可能であり、 NULL にすることができます。 ポインターが NULL の場合、大きなアイコンは読み込まれません。
[out, optional] MiniIconIndex
指定したクラスのミニ アイコンのインデックスを受け取る INT 型の変数へのポインター。 ミニ アイコンは、デバイス インストーラーのミニ アイコン キャッシュに格納されます。 ポインターは省略可能であり、 NULL にすることができます。
戻り値
成功した場合、この関数は TRUE を 返します。 それ以外の場合は FALSE を 返し、ログに記録されたエラーは GetLastError の呼び出しによって取得できます。
解説
クラスのアイコンは定義済みで、デバイス インストーラーの内部キャッシュから読み込まれるか、クラス インストーラーの実行可能ファイルから直接読み込まれます。 この関数は、指定したクラスのセクションのレジストリ値 ICON に対してクエリを実行します。 ICON 値を指定すると、読み込むミニ アイコンが示されます。
ICON 値が負の場合、絶対値はクラスのレジストリ内の定義済みのアイコンを表します。 定義済みのミニ アイコンの一覧については、「 SetupDiDrawMiniIcon 」を参照してください。
ICON 値が正の場合は、抽出されるクラス インストーラーの実行可能イメージ内のアイコンを表します。 値 1 は予約済みです。 また、この関数では 、INSTALLER32 レジストリ値と ENUMPROPPAGES32 レジストリ値を使用して、アイコンを抽出する実行可能イメージを決定します。 これらのレジストリ値の詳細については、「 INF ClassInstall32」セクションを参照してください。
呼び出し元がアイコンを使用して終了したら、呼び出し元は DestroyIcon を呼び出す必要があります (Microsoft Windows SDKドキュメントで説明されています)。
LargeIcon パラメーターを指定しても ClassGuid パラメーターが有効なクラス GUID を指定しない場合、またはクラスの Icon レジストリ値が無効な場合、SetupDiLoadClassIcon は既定の大きなアイコンを読み込み、大きなアイコンのハンドルを返し、MiniIconIndex パラメーターが指定されている場合は、既定のミニ アイコンのインデックスを返します。
要件
| サポートされている最小のクライアント | Microsoft Windows 2000 以降のバージョンの Windows で使用できます。 |
| 対象プラットフォーム | デスクトップ |
| Header | setupapi.h (Setupapi.h を含む) |
| Library | Setupapi.lib |
| [DLL] | Setupapi.dll |