Fonction SetupDiGetHwProfileFriendlyNameExA (setupapi.h)
La fonction SetupDiGetHwProfileFriendlyNameEx récupère le nom convivial associé à un ID de profil matériel sur un ordinateur local ou distant.
Syntaxe
WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameExA(
[in] DWORD HwProfile,
[out] PSTR FriendlyName,
[in] DWORD FriendlyNameSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
Paramètres
[in] HwProfile
Fournit l’ID de profil matériel associé au nom convivial à récupérer. Si ce paramètre est 0, le nom convivial du profil matériel actuel est récupéré.
[out] FriendlyName
Pointeur vers une mémoire tampon de caractères pour recevoir le nom convivial.
[in] FriendlyNameSize
Taille, en caractères, de la mémoire tampon FriendlyName .
[out, optional] RequiredSize
Pointeur vers une variable pour recevoir le nombre de caractères requis pour stocker le nom convivial (y compris une terminaison NULL). Ce paramètre est facultatif et peut être NULL.
[in, optional] MachineName
Pointeur vers une chaîne terminée par null qui contient le nom d’un ordinateur distant sur lequel réside l’ID de profil matériel. Ce paramètre est facultatif et peut être NULL. Si MachineName a la valeur NULL, l’ID de profil matériel se trouve sur l’ordinateur local.
Attention
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
Doit avoir la valeur 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 en effectuant un appel à GetLastError.
Remarques
Notes
L’en-tête setupapi.h définit SetupDiGetHwProfileFriendlyNameEx comme un 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.
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 |