SetupDiGetClassDevPropertySheetsW, 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 sur l’appareil.
Syntaxe
WINSETUPAPI BOOL SetupDiGetClassDevPropertySheetsW(
[in] HDEVINFO DeviceInfoSet,
[in, optional] PSP_DEVINFO_DATA DeviceInfoData,
[in] LPPROPSHEETHEADERW PropertySheetHeader,
[in] DWORD PropertySheetHeaderPageListSize,
[out, optional] PDWORD RequiredSize,
[in] DWORD PropertySheetType
);
Paramètres
[in] DeviceInfoSet
Handle vers le jeu d’informations de l’appareil pour lequel retourner des 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 de l’appareil doit avoir une classe de configuration d’appareil associée.
[in, optional] DeviceInfoData
Pointeur vers une structure SP_DEVINFO_DATA qui spécifie un élément d’informations d’appareil dans DeviceInfoSet.
Ce paramètre est facultatif et peut être NULL. Si ce paramètre est spécifié, SetupDiGetClassDevPropertySheets récupère les handles de feuilles de propriétés associés à l’appareil spécifié. Si ce paramètre est NULL, SetupDiGetClassDevPropertySheets récupère les handles de feuilles de propriétés associés à la classe de configuration de l’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 le Kit de développement logiciel (SDK) Microsoft Windows.
[in] PropertySheetHeaderPageListSize
Nombre maximal de handles que le tableau fourni par l’appelant de handles de feuille de propriétés 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 d’appareil spécifié ou à la classe de configuration de l’appareil spécifiée. 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. N’utilisez pas windows 2000 et versions ultérieures de Windows. |
| DIGCDP_FLAG_REMOTE_ADVANCED | Feuilles de propriétés avancées sur un ordinateur distant. |
Valeur de retour
La fonction retourne VRAI en cas de réussite. Sinon, la fonction retourne faux. 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 les pages de phpages membre est un pointeur vers un tableau de handles de feuille de propriétés fourni par l’appelant, 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 handles de feuille de propriétés au tableau de handles 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 plein 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 le nombre total de handles dans le tableau.
- Définit RequiredSize le nombre de handles qu’il retourne.
- Retourne TRUE.
- Ajoute autant de handles que le tableau peut contenir.
- Définit nPages sur PropertySheetHeaderPageListSize.
- Définit RequiredSize au 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 FAUX.
Note
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. 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 |