SetupDiLoadClassIcon-Funktion (setupapi.h)

  • Artikel

Die SetupDiLoadClassIcon-Funktion lädt sowohl das große als auch das Minisymbol für die angegebene Klasse.

Syntax

WINSETUPAPI BOOL SetupDiLoadClassIcon(
  [in]            const GUID *ClassGuid,
  [out, optional] HICON      *LargeIcon,
  [out, optional] PINT       MiniIconIndex
);

Parameter

[in] ClassGuid

Ein Zeiger auf die GUID der Klasse, für die die Symbole geladen werden sollen.

[out, optional] LargeIcon

Ein Zeiger auf ein Symbolhandle, das den Handle-Wert für das geladene große Symbol für die angegebene Klasse empfängt. Dieser Zeiger ist optional und kann NULL sein. Wenn der Zeiger NULL ist, wird das große Symbol nicht geladen.

[out, optional] MiniIconIndex

Ein Zeiger auf eine INT-typisierte Variable, die den Index des Minisymbols für die angegebene Klasse empfängt. Das Minisymbol wird im Minisymbolcache des Geräteinstallationsprogramms gespeichert. Der Zeiger ist optional und kann NULL sein.

Rückgabewert

Die Funktion gibt TRUE zurück, wenn sie erfolgreich ist. Andernfalls wird FALSE zurückgegeben, und der protokollierte Fehler kann durch einen Aufruf von GetLastError abgerufen werden.

Hinweise

Die Symbole der Klasse sind entweder vordefiniert und aus dem internen Cache des Geräteinstallationsprogramms geladen, oder sie werden direkt aus der ausführbaren Datei des Klasseninstallationsprogramms geladen. Diese Funktion fragt den Registrierungswert ICON im Abschnitt der angegebenen Klasse ab. Wenn der ICON-Wert angegeben ist, gibt er an, welches Minisymbol geladen werden soll.

Wenn der ICON-Wert negativ ist, stellt der absolute Wert ein vordefiniertes Symbol in der Registrierung der Klasse dar. Eine Liste der vordefinierten Minisymbole finden Sie unter SetupDiDrawMiniIcon .

Wenn der ICON-Wert positiv ist, stellt er ein Symbol im ausführbaren Image des Klasseninstallationsprogramms dar, das extrahiert wird. Der Wert 1 ist reserviert. Diese Funktion verwendet auch den INSTALLER32 Registrierungswert und dann den ENUMPROPPAGES32 Registrierungswert, um zu bestimmen, aus welchem ausführbaren Image die Symbole extrahiert werden sollen. Weitere Informationen zu diesen Registrierungswerten finden Sie im Abschnitt INF ClassInstall32.

Wenn ein Aufrufer das Symbol verwendet, muss der Aufrufer DestroyIcon aufrufen (was in der Microsoft Windows SDK Dokumentation beschrieben wird).

Wenn der LargeIcon-Parameter angegeben ist, der ClassGuid-Parameter jedoch keine gültige Klassen-GUID liefert oder der Icon-Registrierungswert der Klasse ungültig ist, lädt SetupDiLoadClassIcon das große Standardsymbol, gibt das Handle für das große Symbol zurück, und gibt den Index des Standardminisymbols zurück, wenn der MiniIconIndex-Parameter angegeben ist.

Anforderungen

   
Unterstützte Mindestversion (Client) Verfügbar in Microsoft Windows 2000 und höheren Versionen von Windows.
Zielplattform Desktop
Kopfzeile setupapi.h (einschließlich Setupapi.h)
Bibliothek Setupapi.lib
DLL Setupapi.dll

Weitere Informationen

SetupDiDrawMiniIcon

SetupDiGetClassBitmapIndex