Fonction de rappel PFNPROPSHEETUI (compstui.h)

Le type de fonction PFNPROPSHEETUI est utilisé par les applications CPSUI (y compris les DLL d’interface d’imprimante) pour définir des rappels de création de page, qui spécifient des pages de feuille de propriétés à créer.

Syntaxe

PFNPROPSHEETUI Pfnpropsheetui;

LONG Pfnpropsheetui(
  PPROPSHEETUI_INFO pPSUIInfo,
  LPARAM lParam
)
{...}

Paramètres

pPSUIInfo

Pointeur fourni par CPSUI vers une structure PROPSHEETUI_INFO .

lParam

Valeur entière fournie par CPSUI qui dépend du contenu du membre Reason de la structure PROPSHEETUI_INFO . Les valeurs valides sont les suivantes :

PROPSHEETUI_REASON_BEFORE_INIT

Cette valeur est nouvelle pour Windows 8 et elle est fournie uniquement au paramètre PFNPROPSHEETUI d’origine passé à CommonPropertySheetUI.

PROPSHEETUI_REASON_DESTROY

La valeur lParam est différente de zéro si l’utilisateur a sélectionné le bouton OK ou Annuler de la feuille de propriétés. Sinon, la valeur est égale à zéro.

PROPSHEETUI_REASON_GET_ICON

La valeur lParam est un pointeur vers une structure PROPSHEETUI_GETICON_INFO .

PROPSHEETUI_REASON_GET_INFO_HEADER

La valeur lParam est un pointeur vers une structure PROPSHEETUI_INFO_HEADER .

PROPSHEETUI_REASON_INIT

Si la fonction de rappel est spécifiée par le paramètre pfnPropSheetUI sur CommonPropertySheetUI, lParam est la valeur lParam passée à CommonPropertySheetUI.

Si la fonction de rappel est spécifiée à l’aide du code de fonction CPSFUNC_ADD_PFNPROPSHEETUI avec la fonction ComPropSheet de CPSUI, lParam est la valeur lParam2 passée à ComPropSheet.

CPSUI copie la valeur lParam dans le membre lParamInit de la structure PROPSHEETUI_INFO de la fonction.

La valeur lParam ne doit pas résider sur la pile de l’application.

PROPSHEETUI_REASON_SET_RESULT

La valeur lParam est un pointeur vers une structure SETRESULT_INFO .

Valeur retournée

Si l’opération réussit, la fonction doit retourner une valeur de une (ou supérieure). Sinon, elle doit retourner une valeur inférieure à une.

Code de retour Description
Un ou une version supérieure. La fonction PFNPROPSHEETUI associée au parent de la page active est appelée.
Inférieur à 1. La fonction PFNPROPSHEETUI associée au parent de la page active ne sera pas appelée.

Remarques

Les fonctions de rappel spécifiées à l’aide du type de fonction PFNPROPSHEETUI sont fournies par les applications qui utilisent CPSUI pour gérer les pages de feuille de propriétés personnalisées. Une fonction de rappel de ce type doit être spécifiée lorsqu’une application appelle la fonction CommonPropertySheetUI . Par exemple, lorsque le spouleur d’impression du système d’exploitation NT appelle la fonction CommonPropertySheetUI de CPSUI pour prendre en charge ses fonctions DocumentProperties ou PrinterProperties , le spouleur spécifie une fonction de rappel interne de type PFNPROPSHEETUI.

Les applications peuvent spécifier des fonctions de rappel supplémentaires de type PFNPROPSHEETUI en appelant la fonction ComPropSheet de CPSUI avec un code de fonction de CPSFUNC_ADD_PFNPROPSHEETUI. Par exemple, le spouleur d’impression du système d’exploitation NT effectue cette opération pour informer CPSUI de l’existence des fonctions DrvDocumentPropertySheets et DrvDevicePropertySheets d’une DLL d’interface d’imprimante. De même, les pilotes Unidrv et Pscript de Microsoft utilisent cette technique pour informer CPSUI de l’existence des méthodes IPrintOemUI ::D ocumentPropertySheets et IPrintOemUI ::D evicePropertySheets dans les plug-ins d’interface utilisateur.

Chaque fonction de rappel de type PFNPROPSHEETUI est appelée par CPSUI plusieurs fois. Le membre Reason de la structure PROPSHEETUI_INFO stipule l’opération que la fonction doit effectuer, comme suit :

Configuration requise

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