SetupDiGetClassDescriptionExW, fonction (setupapi.h)
La fonction SetupDiGetClassDescriptionEx récupère la description d’une classe d’installation installée sur un ordinateur local ou distant.
Syntaxe
WINSETUPAPI BOOL SetupDiGetClassDescriptionExW(
[in] const GUID *ClassGuid,
[out] PWSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCWSTR MachineName,
PVOID Reserved
);
Paramètres
[in] ClassGuid
Pointeur vers le GUID de la classe d’installation 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 vers laquelle pointe le paramètre ClassDescription . La longueur maximale, en caractères, d’une description de classe terminée par NULL est LINE_LEN. Pour plus d’informations, consultez la section Notes suivante.
[out, optional] RequiredSize
Pointeur vers une variable de type DWORD qui reçoit la taille, en caractères, requise pour stocker la description de classe terminée par NULL demandée. Ce pointeur est facultatif et peut être NULL.
[in, optional] MachineName
Pointeur vers une chaîne terminée par NULL qui fournit le nom d’un ordinateur distant sur lequel réside la classe d’installation. Ce pointeur est facultatif et peut être NULL. Si la classe est installée sur un ordinateur local, définissez le pointeur sur NULL.
Reserved
Réservé pour le système. Un appelant de cette fonction doit définir ce paramètre sur NULL.
Valeur retournée
La fonction retourne TRUE si elle réussit. Sinon, elle retourne FALSE et l’erreur journalisée peut être récupérée avec un appel à GetLastError.
Remarques
S’il existe un nom convivial dans la clé de Registre pour la classe, cette routine retourne le nom convivial. Sinon, cette routine retourne le nom de la classe.
SetupDiGetClassDescriptionEx n’applique pas de restriction sur la longueur de la description de classe qu’il peut retourner. Cette fonction retourne la taille requise pour une description de classe terminée par NULL, même si elle est supérieure à LINE_LEN. Toutefois, LINE_LEN est la longueur maximale d’une description de classe terminée par NULL valide. Un appelant ne doit jamais avoir besoin d’une mémoire tampon supérieure à LINE_LEN.
Notes
L’en-tête setupapi.h définit SetupDiGetClassDescriptionEx comme 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. La combinaison 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.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Disponible dans Microsoft Windows 2000 et versions ultérieures de Windows. |
| Plateforme cible | Desktop (Expérience utilisateur) |
| En-tête | setupapi.h (inclure Setupapi.h) |
| Bibliothèque | Setupapi.lib |