SetupDiGetClassDevPropertySheetsA, fonction (setupapi.h)

La fonction SetupDiGetClassDevPropertySheets récupère les handles dans les feuilles de propriétés d’un élément d’informations d’appareil ou de la classe de configuration d’appareil d’un jeu d’informations d’appareil.

Syntaxe

WINSETUPAPI BOOL SetupDiGetClassDevPropertySheetsA(
  [in]            HDEVINFO           DeviceInfoSet,
  [in, optional]  PSP_DEVINFO_DATA   DeviceInfoData,
  [in]            LPPROPSHEETHEADERA PropertySheetHeader,
  [in]            DWORD              PropertySheetHeaderPageListSize,
  [out, optional] PDWORD             RequiredSize,
  [in]            DWORD              PropertySheetType
);

Paramètres

[in] DeviceInfoSet

Handle vers le jeu d’informations d’appareil pour lequel retourner les handles de feuille de propriétés. Si DeviceInfoData ne spécifie pas d’élément d’informations sur l’appareil dans le jeu d’informations sur l’appareil, le jeu d’informations sur l’appareil doit avoir une classe de configuration d’appareil associée.

[in, optional] DeviceInfoData

Pointeur vers une structure de SP_DEVINFO_DATA qui spécifie 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é, SetupDiGetClassDevPropertySheets récupère les descripteurs de feuilles de propriétés associés à l’appareil spécifié. Si ce paramètre a la valeur NULL, SetupDiGetClassDevPropertySheets récupère les descripteurs de feuilles de propriétés associés à la classe d’installation d’appareil spécifiée dans DeviceInfoSet.

[in] PropertySheetHeader

Pointeur vers une structure PROPERTYSHEETHEADER. Consultez la section Remarques pour plus d’informations sur le tableau fourni par l’appelant de handles de feuille de propriétés associé à cette structure.

Pour plus de documentation sur cette structure et les feuilles de propriétés en général, consultez la Microsoft Windows SDK.

[in] PropertySheetHeaderPageListSize

Nombre maximal de handles que le tableau de poignées de feuille de propriétés fourni par l’appelant peut contenir.

[out, optional] RequiredSize

Pointeur vers une variable de type DWORD qui reçoit le nombre de feuilles de propriétés associées à l’élément d’informations sur l’appareil spécifié ou à la classe de configuration de l’appareil du jeu d’informations sur l’appareil spécifié. Le pointeur est facultatif et peut être NULL.

[in] PropertySheetType

Indicateur qui indique l’un des types suivants de feuilles de propriétés.

Type de feuille de propriétés	Signification
DIGCDP_FLAG_ADVANCED	Feuilles de propriétés avancées.
DIGCDP_FLAG_BASIC	Feuilles de propriétés de base. Pris en charge uniquement dans Microsoft Windows 95 et Windows 98. Ne pas utiliser dans Windows 2000 et les versions ultérieures de Windows.
DIGCDP_FLAG_REMOTE_ADVANCED	Feuilles de propriétés avancées sur un ordinateur distant.

Valeur retournée

La fonction retourne TRUE en cas de réussite. Sinon, la fonction retourne FALSE. Appelez GetLastError pour obtenir le code d’erreur.

Remarques

Une structure PROPERTYSHEETHEADER contient deux membres associés à un tableau fourni par l’appelant que la fonction utilise pour retourner les handles des feuilles de propriétés. Le membre phpages est un pointeur vers un tableau fourni par l’appelant de handles de feuille de propriétés, et la valeur d’entrée du membre nPages spécifie le nombre de handles qui sont déjà contenus dans le tableau de handles. La fonction ajoute des poignées de feuille de propriétés au tableau de handles en commençant par l’élément de tableau dont l’index de tableau est la valeur d’entrée de nPages. La fonction ajoute des handles au tableau dans l’ordre consécutif jusqu’à ce que le tableau soit saturé ou que les handles de toutes les pages de feuille de propriétés demandées aient été ajoutés au tableau. Le nombre maximal de handles de feuille de propriétés que la fonction peut retourner est égal à (PropertySheetHeaderPageListSize - (valeur d’entrée de nPages)).

Si le tableau de handles est suffisamment grand pour contenir les handles de toutes les pages de feuille de propriétés demandées, la fonction :

• Ajoute les handles au tableau de handles.
• Définit nPages sur le nombre total de handles dans le tableau.
• Définit RequiredSize sur le nombre de handles qu’il retourne.
• Retourne TRUE.

Si le tableau de handles n’est pas assez grand pour contenir les handles de toutes les pages de feuille de propriétés spécifiées, la fonction :

• Ajoute autant de handles que le tableau peut contenir.
• Définit nPages sur PropertySheetHeaderPageListSize.
• Définit RequiredSize sur le nombre total de pages de feuille de propriétés demandées. Le nombre de handles qui ne sont pas retournés par la fonction est égal à (RequiredSize - PropertySheetHeaderPageListSize - (valeur d’entrée de nPages)).
• Définit le code d’erreur sur ERROR_INSUFFICIENT_BUFFER.
• Retourne FALSE.

Notes

L’en-tête setupapi.h définit SetupDiGetClassDevPropertySheets en tant qu’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. La combinaison 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

SP_DEVINFO_DATA