SetupDiGetClassDescriptionW, fonction (setupapi.h)
La fonction SetupDiGetClassDescription récupère la description de classe associée au GUID de classe d’installation spécifié.
Syntaxe
WINSETUPAPI BOOL SetupDiGetClassDescriptionW(
[in] const GUID *ClassGuid,
[out] PWSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize
);
Paramètres
[in] ClassGuid
GUID de la classe setup dont la description doit être récupérée.
[out] ClassDescription
Pointeur vers une mémoire tampon de caractères qui reçoit la description de la classe.
[in] ClassDescriptionSize
Taille, en caractères, de la mémoire tampon ClassDescription.
[out, optional] RequiredSize
Pointeur vers une variable de type DWORD qui reçoit la taille, en caractères, qui est nécessaire pour stocker la description de la classe (y compris un terminateur NULL). RequiredSize est toujours inférieur à LINE_LEN. Ce paramètre est facultatif et peut être NULL.
Valeur de retour
La fonction retourne TRUE si elle réussit. Sinon, elle retourne FAUX et l’erreur journalisée peut être récupérée avec un appel à GetLastError.
Remarques
Appelez SetupDiGetClassDescriptionEx pour récupérer la description d’une classe d’installation installée sur un ordinateur distant.
Note
L’en-tête setupapi.h définit SetupDiGetClassDescription en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Disponible dans Microsoft Windows 2000 et versions ultérieures de Windows. |
| plateforme cible | Bureau |
| d’en-tête | setupapi.h (include Setupapi.h) |
| bibliothèque | Setupapi.lib |
| ensemble d’API | ext-ms-win-setupapi-classinstallers-l1-1-2 (introduit dans Windows 10, version 10.0.14393) |