PropertySheetA, fonction (prsht.h)

Article
11/20/2024

Crée une feuille de propriétés et ajoute les pages définies dans la structure d’en-tête de feuille de propriétés spécifiée.

Syntaxe

INT_PTR PropertySheetA(
  LPCPROPSHEETHEADERA unnamedParam1
);

Paramètres

unnamedParam1

Type : LPCPROPSHEETHEADER

Pointeur vers une structure PROPSHEETHEADER qui définit le cadre et les pages d’une feuille de propriétés.

Valeur de retour

Type : INT_PTR

Pour les feuilles de propriétés modales, la valeur de retour est la suivante :

>=1	Les modifications ont été enregistrées par l’utilisateur.
0	Aucune modification n’a été enregistrée par l’utilisateur.
-1	Une erreur s’est produite.

Pour les feuilles de propriétés sans mode, la valeur de retour est la poignée de fenêtre de la feuille de propriétés.

Les valeurs de retour suivantes ont une signification particulière.

Retourner le code	Description
ID_PSREBOOTSYSTEM	Une page a envoyé le message PSM_REBOOTSYSTEM à la feuille de propriétés. L’ordinateur doit être redémarré pour que les modifications de l’utilisateur prennent effet.
ID_PSRESTARTWINDOWS	Une page a envoyé le message PSM_RESTARTWINDOWS à la feuille de propriétés. Windows doit être redémarré pour que les modifications de l’utilisateur prennent effet.

Remarques

Pour récupérer des informations d’erreur étendues, appelez GetLastError.

Si vous tentez d’ajouter plus de 99 pages à une feuille de propriétés, cette fonction échoue, mais sans indication de la cause de l’erreur : PropertySheet retourne une valeur -1, mais GetLastError retourne 0.

Remarque Les remarques suivantes font référence uniquement aux Assistants qui n’utilisent pas le style de l’Assistant Aero (PSH_AEROWIZARD) ou les feuilles de propriétés non-Assistant.

Par défaut, la fonction PropertySheet crée une boîte de dialogue modale. Si le dwFlags membre de la structure PROPSHEETHEADER spécifie l’indicateur PSH_MODELESS, PropertySheet crée une boîte de dialogue sans mode et retourne immédiatement après sa création. Dans ce cas, la PropertySheet valeur de retour est la poignée de fenêtre de la boîte de dialogue sans mode.

Pour une feuille de propriétés sans mode, votre boucle de message doit utiliser PSM_ISDIALOGMESSAGE pour transmettre des messages à la boîte de dialogue feuille de propriétés. Votre boucle de message doit utiliser PSM_GETCURRENTPAGEHWND pour déterminer quand détruire la boîte de dialogue. Lorsque l’utilisateur clique sur le bouton OK ou Annuler, PSM_GETCURRENTPAGEHWND retourne NULL. Vous pouvez ensuite utiliser la fonction DestroyWindow pour détruire la boîte de dialogue.

Version 5.80. La PropertySheet valeur de retour contient différentes informations pour les feuilles de propriétés modales et sans mode. Dans certains cas, les feuilles de propriétés sans mode peuvent avoir besoin des informations qu’elles auraient reçues de PropertySheet si elles avaient été modales. En particulier, ils peuvent avoir besoin de savoir si ID_PSREBOOTSYSTEM ou ID_PSRESTARTWINDOWS auraient été renvoyés. Une feuille de propriétés sans mode peut récupérer la valeur qu’une feuille de propriétés modale aurait reçue de PropertySheet en attendant que PSM_GETCURRENTPAGEHWND retourne NULL, puis en envoyant un message PSM_GETRESULT.

Note

L’en-tête prsht.h définit PropertySheet 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	Windows Vista [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	prsht.h
bibliothèque	Comctl32.lib
DLL	Comctl32.dll
ensemble d’API	ext-ms-win-shell-comctl32-window-l1-1-0 (introduit dans Windows 10, version 10.0.14393)

Partager via