SetupDiGetHwProfileListExA, fonction (setupapi.h)
La fonction SetupDiGetHwProfileListEx récupère une liste de tous les ID de profil matériel actuellement définis sur un ordinateur local ou distant.
Syntaxe
WINSETUPAPI BOOL SetupDiGetHwProfileListExA(
[out] PDWORD HwProfileList,
[in] DWORD HwProfileListSize,
[out] PDWORD RequiredSize,
[out, optional] PDWORD CurrentlyActiveIndex,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
Paramètres
[out] HwProfileList
Pointeur vers un tableau pour recevoir la liste des ID de profil matériel actuellement définis.
[in] HwProfileListSize
Nombre de DWORD dans la mémoire tampon HwProfileList
[out] RequiredSize
Pointeur vers une variable de type DWORD qui reçoit le nombre de profils matériels actuellement définis. Si le nombre est supérieur à HwProfileListSize, la liste est tronquée pour correspondre à la taille du tableau. La valeur retournée dans RequiredSize indique la taille du tableau requise pour stocker la liste complète des profils matériels.
[out, optional] CurrentlyActiveIndex
Pointeur vers une variable qui reçoit l’index du profil matériel actif dans la liste des profils matériels récupérés. 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 système distant pour lequel récupérer la liste des ID de profil matériel. Ce paramètre est facultatif et peut être NULL. Si ce paramètre est NULL, la liste est récupérée pour le système local.
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
Doit ê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 en effectuant un appel à GetLastError. Si la taille requise est supérieure à HwProfileListSize, SetupDiGetHwProfileListEx retourne FALSE et un appel à GetLastError retourne ERROR_INSUFFICIENT_BUFFER.
Remarques
Note
L’en-tête setupapi.h définit SetupDiGetHwProfileListEx 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 |