SetupDiGetClassDescriptionExA, 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 SetupDiGetClassDescriptionExA(
[in] const GUID *ClassGuid,
[out] PSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR 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 pointée par 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 suivante Remarques.
[out, optional] RequiredSize
Pointeur vers une variable typée DWORD qui reçoit la taille, en caractères, qui est nécessaire pour stocker la description de classe 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 .
Prudence
L’utilisation de cette fonction pour accéder aux machines distantes n’est pas prise en charge à partir de Windows 8 et Windows Server 2012, car cette fonctionnalité a été supprimée.
Reserved
Réservé à l’utilisation du système. Un appelant de cette fonction doit définir ce paramètre sur 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
S’il existe un nom convivial dans la clé de Registre de 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’elle 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.
Note
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. 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 |