Fonction SetupDiLoadClassIcon (setupapi.h)

La fonction SetupDiLoadClassIcon charge à la fois la grande et la mini-icône pour la classe spécifiée.

Syntaxe

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

Paramètres

[in] ClassGuid

Pointeur vers le GUID de la classe pour laquelle les icônes doivent être chargées.

[out, optional] LargeIcon

Pointeur vers un handle d’icône qui reçoit la valeur de handle pour l’icône volumineuse chargée pour la classe spécifiée. Ce pointeur est facultatif et peut avoir la valeur NULL. Si le pointeur a la valeur NULL, la grande icône n’est pas chargée.

[out, optional] MiniIconIndex

Pointeur vers une variable de type INT qui reçoit l’index de la mini-icône pour la classe spécifiée. La mini-icône est stockée dans le cache de mini-icônes du programme d’installation de l’appareil. Le pointeur est facultatif et peut être NULL.

Valeur retournée

La fonction retourne TRUE si elle réussit. Sinon, il retourne FALSE et l’erreur journalisée peut être récupérée par un appel à GetLastError.

Remarques

Les icônes de la classe sont prédéfinies et chargées à partir du cache interne du programme d’installation de l’appareil, ou elles sont chargées directement à partir de l’exécutable du programme d’installation de classe. Cette fonction interroge la valeur de Registre ICON dans la section de la classe spécifiée. Si la valeur ICON est spécifiée, elle indique la mini-icône à charger.

Si la valeur ICON est négative, la valeur absolue représente une icône prédéfinie dans le Registre de la classe. Consultez SetupDiDrawMiniIcon pour obtenir la liste des mini-icônes prédéfinies.

Si la valeur ICON est positive, elle représente une icône dans l’image exécutable du programme d’installation de classe qui sera extraite. La valeur 1 est réservée. Cette fonction utilise également la valeur de Registre INSTALLER32 , puis la valeur de Registre ENUMPROPPAGES32 pour déterminer l’image exécutable à partir de laquelle extraire les icônes. Pour plus d’informations sur ces valeurs de Registre, consultez la section INF ClassInstall32.

Lorsqu’un appelant a terminé d’utiliser l’icône, l’appelant doit appeler DestroyIcon (qui est décrit dans la documentation Microsoft Windows SDK).

Si le paramètre LargeIcon est spécifié, mais que le paramètre ClassGuid ne fournit pas de GUID de classe valide ou que la valeur de registre Icon de la classe n’est pas valide, SetupDiLoadClassIcon charge l’icône grande par défaut, retourne le handle pour l’icône volumineuse et, si le paramètre MiniIconIndex est spécifié, retourne l’index de la mini-icône par défaut.

Configuration requise

Voir aussi

SetupDiDrawMiniIcon

SetupDiGetClassBitmapIndex