Fonction SetupDiGetClassInstallParamsA (setupapi.h)

Article
03/04/2024

La fonction SetupDiGetClassInstallParams récupère les paramètres d’installation de classe pour un jeu d’informations d’appareil ou un élément d’informations d’appareil particulier.

Syntaxe

WINSETUPAPI BOOL SetupDiGetClassInstallParamsA(
  [in]            HDEVINFO                DeviceInfoSet,
  [in, optional]  PSP_DEVINFO_DATA        DeviceInfoData,
  [out, optional] PSP_CLASSINSTALL_HEADER ClassInstallParams,
  [in]            DWORD                   ClassInstallParamsSize,
  [out, optional] PDWORD                  RequiredSize
);

Paramètres

[in] DeviceInfoSet

Handle d’un jeu d’informations d’appareil qui contient les paramètres d’installation de classe à récupérer.

[in, optional] DeviceInfoData

Pointeur vers une structure SP_DEVINFO_DATA qui a spécifié un élément d’informations sur l’appareil dans DeviceInfoSet. Ce paramètre est facultatif et peut être NULL. Si ce paramètre est spécifié, SetupDiGetClassInstallParams récupère les paramètres d’installation de classe pour l’appareil spécifié. Si ce paramètre a la valeur NULL, SetupDiGetClassInstallParams récupère les paramètres d’installation de classe pour la liste de pilotes de classe globale associée à DeviceInfoSet.

[out, optional] ClassInstallParams

Pointeur vers une mémoire tampon qui contient une structure SP_CLASSINSTALL_HEADER . Le membre cbSize de cette structure doit être défini sur sizeof(SP_CLASSINSTALL_HEADER) en entrée, sinon la mémoire tampon n’est pas valide. À la sortie, le membre InstallFunction est rempli avec le code de la fonction d’installation de l’appareil pour les paramètres d’installation de classe récupérés. Si la mémoire tampon est suffisamment grande, elle reçoit également la structure des paramètres d’installation de classe spécifique au code de fonction. Si ClassInstallParams n’est pas spécifié, ClassInstallParamsSize doit avoir la valeur 0.

[in] ClassInstallParamsSize

Taille, en octets, de la mémoire tampon ClassInstallParams . Si la mémoire tampon est fournie, elle doit être au moins aussi grande que sizeof(SP_CLASSINSTALL_HEADER). Si la mémoire tampon n’est pas fournie, ClassInstallParamsSize doit être 0.

[out, optional] RequiredSize

Pointeur vers une variable de type DWORD qui reçoit le nombre d’octets requis pour stocker les paramètres d’installation de la classe. Ce paramètre est facultatif et peut être 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 avec un appel à GetLastError.

Remarques

Les paramètres d’installation de classe sont spécifiques à un code de fonction d’installation d’appareil particulier qui est stocké dans le champ ClassInstallHeader situé au début de la mémoire tampon ClassInstallParams .

Notes

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

SetupDiSetClassInstallParams

Partager via