Fonction SetupDiLoadDeviceIcon (setupapi.h)

Article
03/04/2024

La fonction SetupDiLoadDeviceIcon récupère une icône pour un appareil spécifié.

Syntaxe

WINSETUPAPI BOOL SetupDiLoadDeviceIcon(
  [in]  HDEVINFO         DeviceInfoSet,
  [in]  PSP_DEVINFO_DATA DeviceInfoData,
  [in]  UINT             cxIcon,
  [in]  UINT             cyIcon,
  [in]  DWORD            Flags,
  [out] HICON            *hIcon
);

Paramètres

[in] DeviceInfoSet

Handle du jeu d’informations sur l’appareil qui contient l’élément d’informations sur l’appareil qui représente l’appareil pour lequel récupérer une icône.

[in] DeviceInfoData

Pointeur vers une structure de SP_DEVINFO_DATA qui spécifie l’élément d’informations sur l’appareil dans DeviceInfoSet.

[in] cxIcon

Largeur, en pixels, de l’icône à récupérer. Utilisez l’index de métrique système SM_CXICON pour spécifier une icône de taille par défaut ou utilisez l’index de métrique système SM_CXSMICON pour spécifier une petite icône. Les index de métrique système sont définis dans Winuser.h et leurs valeurs associées peuvent être récupérées par un appel à la fonction GetSystemMetrics . (La fonction GetSystemMetrics est documentée dans le Microsoft Windows SDK.)

[in] cyIcon

Hauteur, en pixels, de l’icône à récupérer. Utilisez SM_CXICON pour spécifier une icône de taille par défaut ou utilisez SM_CXSMICON pour spécifier une petite icône.

[in] Flags

Non utilisé. Doit être défini sur zéro.

[out] hIcon

Pointeur vers un handle vers une icône qui reçoit un handle vers l’icône que cette fonction récupère. Une fois l’application qui appelle cette fonction terminée à l’aide de l’icône, l’application doit appeler DestroyIcon pour supprimer l’icône. (DestroyIcon est documenté dans le Microsoft Windows SDK.)

Valeur retournée

SetupDiLoadDeviceIcon retourne TRUE si la fonction réussit à récupérer l’icône pour l’appareil spécifié. Sinon, la fonction retourne FALSE et l’erreur journalisée peut être récupérée par un appel à GetLastError.

Remarques

SetupDiLoadDeviceIcon tente de récupérer une icône pour l’appareil comme suit :

Si la propriété d’appareil DEVPKEY_DrvPkg_Icon de l’appareil inclut une liste de chaînes d’identificateur de ressource, la fonction tente de récupérer l’icône spécifiée par la première chaîne d’identificateur de ressource de la liste.
Le type de données de propriété d’appareil de la propriété d’appareil DEVPKEY_DrvPkg_Icon est DEVPROP_TYPE_STRING_LIST.

Le format d’une chaîne d’identificateur de ressource est
```
[filepath\]filename,-resourceID
```
Où :
- filepath, suivi du caractère barre oblique inverse (\\), est facultatif et spécifie un chemin d’accès du fichier qui contient l’icône.
- FileName, suivi du caractère de virgule (« , ») spécifie le nom du fichier qui contient l’icône.
- ResourceID, précédé d’un tiret ( » - « ), spécifie l’ID de ressource de l’icône.
Si la fonction ne peut pas récupérer une icône spécifique à l’appareil, elle tente alors de récupérer l’icône de classe pour l’appareil. Pour plus d’informations sur les icônes de classe, consultez SetupDiLoadClassIcon.
Si la fonction ne peut pas récupérer l’icône de classe pour l’appareil, elle tente alors de récupérer l’icône de la classe d’installation d’appareil inconnu, où l’icône de la classe d’installation d’appareil inconnu inclut l’image d’un point d’interrogation ( ?).

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows Vista et les versions plus récentes de Windows.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	setupapi.h (inclure Setupapi.h)
Bibliothèque	Setupapi.lib
DLL	Setupapi.dll

Voir aussi

DEVPROP_TYPE_STRING_LIST

SetupDiLoadClassIcon

Partager via