CommonPropertySheetUIA, fonction (compstui.h)
La fonction CommonPropertySheetUI de CPSUI affiche les pages de feuille de propriétés et permet aux utilisateurs de modifier les valeurs affichées.
Syntaxe
LONG CommonPropertySheetUIA(
HWND hWndOwner,
PFNPROPSHEETUI pfnPropSheetUI,
LPARAM lParam,
LPDWORD pResult
);
Paramètres
hWndOwner
Handle de fenêtre fourni par l’appelant identifiant la fenêtre dans laquelle de nouvelles pages de feuille de propriétés doivent être placées.
pfnPropSheetUI
Pointeur fourni par l’appelant vers une fonction de rappel PFNPROPSHEETUI-typé.
lParam
Valeur fournie par l’appelant utilisée comme argument d’entrée pour la fonction pfnPropSheetUI. Cette valeur peut être un pointeur.
pResult
Pointeur fourni par l’appelant vers un DWORD qui reçoit l’état final de retour de la fonction pfnPropSheetUI. Si NULL, l’état final de retour n’est pas retourné. Pour plus d’informations, consultez la section Remarques suivante.
Valeur de retour
La fonction CommonPropertySheetUI retourne l’une des valeurs suivantes :
| Retourner le code | Description |
|---|---|
| CPSUI_CANCEL | La fonction pfnPropSheetUI a retourné une valeur négative. |
| CPSUI_OK | L’opération a réussi. |
| CPSUI_REBOOTSYSTEM | L’opération a réussi et une procédure de boîte de dialogue a envoyé le message PSM_REBOOTSYSTEM. |
| CPSUI_RESTARTWINDOWS | L’opération a réussi et une procédure de boîte de dialogue a envoyé le message PSM_RESTARTWINDOWS. |
| code d’erreur ERR_CPSUI préfixe | Une défaillance s’est produite. Les codes d’erreur ERR_CPSUI préfixés sont définis dans compstui.h. |
Remarques
La fonction CommonPropertySheetUI est le point d’entrée de CPSUI pour les applications. Une application CPSUI (telle que le spouleur d’impression du système d’exploitation Microsoft NT) peut appeler la fonction pour ajouter une ou plusieurs pages de feuille de propriétés à une fenêtre parente prédéfinie. CPSUI affiche les pages, permet à l’utilisateur de les modifier et avertit l’application de l’activité de l’utilisateur par le biais de fonctions de rappel.
Le spouleur d’impression du système d’exploitation NT appelle la fonction CommonPropertySheetUI lorsqu’une application Win32 appelle les fonctions DocumentProperties ou PrinterProperties.
La fonction de rappel spécifiée par le paramètre pfnPropSheetUI est chargée de décrire les pages de feuille de propriétés à ajouter. Pour plus d’informations, consultez la description du type de fonction PFNPROPSHEETUI.
La séquence d’opération est la suivante :
La fonction CommonPropertySheetUI appelle le rappel pfnPropSheetUI afin que le rappel puisse décrire les pages à ajouter en appelant la fonction ComPropSheet de CPSUI.
Si le rappel pfnPropSheetUI réussit, la fonction CommonPropertySheetUI affiche les nouvelles pages de feuille de propriétés et permet à l’utilisateur de modifier les valeurs de page.
Si l’utilisateur modifie les valeurs de page, un rappel d’événement de page avertit l’application des modifications.
Lorsque l’utilisateur choisit le bouton OK ou Annuler, la fonction CommonPropertySheetUI détruit les pages affichées et retourne.
Pour plus d’informations sur la séquence d’opération, consultez Using CPSUI with Printer Drivers, dans la section intitulée CPSUI.
La fonction CommonPropertySheetUI appelle en fait le rappel pfnPropSheetUI plusieurs fois, en spécifiant des valeurs membres Reason différentes dans la structure de PROPSHEETUI_INFO du rappel. Chaque fois que le rappel est retourné, il place un état de résultat dans le membre Result de la structure de PROPSHEETUI_INFO. Lorsque la fonction CommonPropertySheetUI retourne, elle copie le contenu final de Result dans l’emplacement vers lequel pointe pResult.
Exigences
| Exigence | Valeur |
|---|---|
| plateforme cible | Bureau |
| d’en-tête | compstui.h (include Compstui.h) |