Partager via


Fonction SetupDiGetHwProfileFriendlyNameA (setupapi.h)

La fonction SetupDiGetHwProfileFriendlyName récupère le nom convivial associé à un ID de profil matériel.

Syntaxe

WINSETUPAPI BOOL SetupDiGetHwProfileFriendlyNameA(
  [in]            DWORD  HwProfile,
  [out]           PSTR   FriendlyName,
  [in]            DWORD  FriendlyNameSize,
  [out, optional] PDWORD RequiredSize
);

Paramètres

[in] HwProfile

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 chaîne pour recevoir le nom convivial.

[in] FriendlyNameSize

Taille, en caractères, de la mémoire tampon FriendlyName .

[out, optional] RequiredSize

Pointeur vers une variable de type DWORD qui reçoit le nombre de caractères requis pour récupérer le nom convivial (y compris une terminaison 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

Appelez SetupDiGetHwProfileFriendlyNameEx pour obtenir le nom convivial d’un ID de profil matériel sur un ordinateur distant.

Notes

L’en-tête setupapi.h définit SetupDiGetHwProfileFriendlyName 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

Voir aussi

SetupDiGetHwProfileFriendlyNameEx

SetupDiGetHwProfileList