Partager via


Fonction DrvDocumentPropertySheets (winddiui.h)

La fonction DrvDocumentPropertySheets d’une DLL d’imprimante est chargée de créer des pages de feuille de propriétés qui décrivent les propriétés d’un document d’impression.

Syntaxe

LONG DrvDocumentPropertySheets(
  [in, optional] PPROPSHEETUI_INFO pPSUIInfo,
                 LPARAM            lParam
);

Paramètres

[in, optional] pPSUIInfo

Pointeur fourni par l’appelant vers une structure PROPSHEETUI_INFO . Peut être NULL (voir la section Remarques suivante).

lParam

Valeur entière fournie par l’appelant qui dépend du contenu du membre Reason de la structure PROPSHEETUI_INFO, comme indiqué dans le tableau suivant.

Valeur de motif Définition de lParam
PROPSHEETUI_REASON_INIT Pointeur vers une structure DOCUMENTPROPERTYHEADER .
Toutes les autres valeurs de raison Consultez la description du paramètre lParam pour le type de fonction PFNPROPSHEETUI . (L’adresse de la structure DOCUMENTPROPERTYHEADER est contenue dans le membre lParamInit de la structure PROPSHEETUI_INFO .)

Valeur retournée

Si pPSUIInfo a la valeur NULL et si lParam ->fMode est égal à zéro ou si lParam ->pdmOut a la valeur NULL, cette fonction doit retourner la taille, en octets, de la structure DEVMODEW de l’imprimante. Sinon, la valeur de retour de la fonction est la même que celle décrite dans la section ReturnValue du type de fonction PFNPROPSHEETUI . Pour plus d'informations, consultez la section Notes.

Notes

Toutes les DLL d’interface d’imprimante doivent fournir une fonction DrvDocumentPropertySheets , qui est définie à l’aide du type de fonction PFNPROPSHEETUI . L’objectif de la fonction est d’appeler la fonction ComPropSheet , fournie par CPSUI, pour spécifier des pages de feuille de propriétés contenant des propriétés modifiables par l’utilisateur pour imprimer des documents.

Si la valeur reçue pour le paramètre pPSUIInfo n’est pas NULL, le spouleur d’impression du système d’exploitation NT appelle la fonction indirectement, via CPSUI. Les règles suivantes s’appliquent :

  • La fonction doit effectuer les opérations décrites pour le type de fonction PFNPROPSHEETUI .

  • Les indicateurs dans le membre fMode de la structure DOCUMENTPROPERTYHEADER indiquent les pages de feuille de propriétés à afficher et si l’utilisateur doit être autorisé à modifier les propriétés d’un document. Les seuls indicateurs qui peuvent être définis sont DM_IN_PROMPT (ou DM_PROMPT), DM_ADVANCED, DM_NOPERMISSION et DM_OUT_BUFFER (ou DM_COPY).

Si la valeur reçue pour le paramètre pPSUIInfo est NULL, le spouleur d’impression appelle la fonction directement, sans passer par CPSUI. Dans ce cas, le paramètre lParam contient l’adresse d’une structure DOCUMENTPROPERTYHEADER, et les règles suivantes s’appliquent :

  • Si le membre fMode de la structure DOCUMENTPROPERTYHEADER est égal à zéro, ou si le membre pdmOut de la même structure est NULL, la fonction doit retourner uniquement la taille totale de la structure DEVMODEW de l’imprimante, y compris les membres de la structure publique et privée, dans le membre cbOut de la structure DOCUMENTPROPERTYHEADER.

  • Si le membre fMode de la structure DOCUMENTPROPERTYHEADER n’est pas égal à zéro, la fonction doit effectuer les opérations indiquées par les indicateurs fMode . Les seuls indicateurs qui peuvent être définis sont DM_IN_BUFFER (ou DM_MODIFY) et DM_OUT_BUFFER (ou DM_COPY).

Configuration requise

Condition requise Valeur
Plateforme cible Desktop (Expérience utilisateur)
En-tête winddiui.h (incluez Winddiui.h)

Voir aussi

DOCUMENTPROPERTYHEADER

DrvDevicePropertySheets

IPrintOemUI ::D ocumentPropertySheets