CommonPropertySheetUIA, fonction (compstui.h)

  • Article

La fonction CommonPropertySheetUI de CPSUI affiche les pages de la 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 les nouvelles pages de feuille de propriétés doivent être placées.

pfnPropSheetUI

Pointeur fourni par l’appelant vers une fonction de rappel de type PFNPROPSHEETUI.

lParam

Valeur fournie par l’appelant qui est 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 le retour final de la fonction pfnPropSheetUI status. Si la valeur est NULL, le status de retour final n’est pas retourné. Pour plus d'informations, consultez la section Notes qui suit.

Valeur retournée

La fonction CommonPropertySheetUI retourne l’une des valeurs suivantes :

Code de retour 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 préfixé par ERR_CPSUI Une défaillance s’est produite. Les codes d’erreur préfixés ERR_CPSUI 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 notifie l’application de l’activité 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 du spouleur.

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 :

  1. La fonction CommonPropertySheetUI appelle le rappel pfnPropSheetUI afin que le rappel puisse décrire les pages à ajouter en appelant la fonction ComPropSheet de CPSUI.

  2. 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.

  3. Si l’utilisateur modifie les valeurs de la page, un rappel d’événement de page notifie l’application des modifications.

  4. 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érations, consultez Utilisation de CPSUI avec des pilotes d’imprimante, dans la section intitulée CPSUI.

La fonction CommonPropertySheetUI appelle en fait le rappel pfnPropSheetUI plusieurs fois, en spécifiant différentes valeurs de membre Reason dans la structure PROPSHEETUI_INFO du rappel. Chaque fois que le rappel est retourné, il place un résultat status dans le membre Result de la structure PROPSHEETUI_INFO. Lorsque la fonction CommonPropertySheetUI est retournée, elle copie le contenu final de Result dans l’emplacement pointé par pResult.

Configuration requise

Condition requise Valeur
Plateforme cible Desktop (Expérience utilisateur)
En-tête compstui.h (inclure Compstui.h)