Fonction de rappel PFNCOMPROPSHEET (compstui.h)

  • Article

La fonction ComPropSheet est fournie par CPSUI et peut être appelée par les applications CPSUI (y compris les DLL d’interface d’imprimante) pour générer des pages de feuille de propriétés.

Syntaxe

PFNCOMPROPSHEET Pfncompropsheet;

LONG_PTR Pfncompropsheet(
  [in] HANDLE hComPropSheet,
  [in] UINT Function,
  [in] LPARAM lParam1,
  [in] LPARAM lParam2
)
{...}

Paramètres

[in] hComPropSheet

Handle fourni par l’appelant à un parent de groupe de feuilles de propriétés. Pour plus d'informations, consultez la section Notes qui suit.

[in] Function

Codes de fonction ComPropSheet avec préfixe CPSFUNC_ fournis par l’appelant spécifiant l’opération à effectuer par la fonction ComPropSheet . Consultez le tableau des codes de fonction ComPropSheet dans la section Notes ci-dessous.

[in] lParam1

Valeur fournie par l’appelant qui dépend du code de fonction ComPropSheet fourni pour Function.

[in] lParam2

Valeur fournie par l’appelant qui dépend du code de fonction ComPropSheet fourni pour Function.

Valeur retournée

La valeur de retour dépend du code de fonction ComPropSheet fourni pour Function.

Remarques

Lorsque CPSUI appelle l’une des fonctions de type PFNPROPSHEETUI d’une application, il passe un pointeur vers la fonction ComPropSheet dans une structure PROPSHEETUI_INFO . Une fonction de type PFNPROPSHEETUI peut appeler la fonction ComPropSheet pour décrire les pages de feuille de propriétés à CPSUI.

Une DLL d’interface d’imprimante peut appeler ComPropSheet à partir de sa fonction DrvDocumentPropertySheets ou de sa fonction DrvDevicePropertySheets .

Les plug-ins d’interface utilisateur pour les pilotes Unidrv et Pscript de Microsoft peuvent appeler ComPropSheet à partir de leurs méthodes IPrintOemUI ::D ocumentPropertySheets et IPrintOemUI ::D evicePropertySheets .

Le handle parent de groupe spécifié pour le paramètre hComPropSheet peut être l’un des suivants :

Codes de fonction ComPropSheet

Les codes de fonction suivants peuvent être passés à la fonction ComPropSheet du CPSUI :

CPSFUNC_ADD_HPROPSHEETPAGE

Le code de la fonction CPSFUNC_ADD_HPROPSHEETPAGE amène la fonction ComPropSheet à ajouter une page de feuille de propriétés qui a été créée en appelant la fonction CreatePropertySheetPage .

Paramètres (CPSFUNC_ADD_HPROPSHEETPAGE)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_ADD_HPROPSHEETPAGE lorsqu’il appelle ComPropSheet pour ajouter une page de feuille de propriétés

  • lParam1 : gérer vers une page de feuille de propriétés, obtenue en appelant la fonction CreatePropertySheetPage

  • lParam2 : non utilisé, doit être égal à zéro

Valeur de retour (CPSFUNC_ADD_HPROPSHEETPAGE)

Si l’opération réussit, ComPropSheet retourne un handle CPSUI à la page ajoutée ; sinon, elle retourne NULL.

CPSFUNC_ADD_PCOMPROPSHEETUI

Le code de la fonction CPSFUNC_ADD_PCOMPROPSHEETUI amène la fonction ComPropSheet à ajouter un ensemble d’une ou plusieurs pages de feuille de propriétés décrites par une structure COMPROPSHEETUI .

Paramètres

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_ADD_PCOMPROPSHEETUI lorsqu’il appelle ComPropSheet pour ajouter un ensemble d’une ou plusieurs pages de feuille de propriétés

  • lParam1 : pointeur vers une structure COMPROPSHEETUI

  • lParam2 : pointeur vers un emplacement 32 bits pour recevoir le nombre de pages ajoutées ou, en cas de défaillance, un code d’erreur préfixé ERR_CPSUI

Valeur retournée

Si l’opération réussit, ComPropSheet retourne un handle à l’ensemble de pages ajoutées ; sinon, la fonction retourne NULL.

CPSFUNC_ADD_PFNPROPSHEETUI

Le code de la fonction CPSFUNC_ADD_PFNPROPSHEETUI amène la fonction ComPropSheet à appeler la fonction de type PFNPROPSHEETUI spécifiée, qui doit ajouter un ensemble d’une ou plusieurs pages de feuille de propriétés.

Paramètres (CPSFUNC_ADD_PFNPROPSHEETUI)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_ADD_PFNPROPSHEETUI lorsqu’il appelle ComPropSheet. ComPropSheet appelle ensuite la fonction de type PFNPROPSHEETUI spécifiée pour ajouter un ensemble d’une ou plusieurs pages de feuille de propriétés.

  • lParam1 : pointeur vers une fonction de type PFNPROPSHEETUI

  • lParam2 : valeur 32 bits passée à la fonction de type PFNPROPSHEETUI pour son paramètre lParam

Valeur de retour (CPSFUNC_ADD_PFNPROPSHEETUI)

Si l’opération réussit, ComPropSheet retourne un handle à l’ensemble de pages ajoutées ; sinon, la fonction retourne NULL.

CPSFUNC_ADD_PROPSHEETPAGE

Le code de la fonction CPSFUNC_ADD_PROPSHEETPAGE amène la fonction ComPropSheet à ajouter le type de page de feuille de propriétés décrit par une structure PROPSHEETPAGE .

Paramètres (CPSFUNC_ADD_PROPSHEETPAGE)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_ADD_PROPSHEETPAGE lorsqu’il appelle ComPropSheet pour ajouter le type de page de feuille de propriétés décrit par une structure PROPSHEETPAGE . La fonction ComPropSheet appelle la fonction CreatePropertySheetPage et transmet l’adresse de la structure PROPSHEETPAGE pour créer la page.

  • lParam1 : pointeur vers une structure PROPSHEETPAGE

  • lParam2 : non utilisé, doit être égal à zéro

Valeur de retour (CPSFUNC_ADD_PROPSHEETPAGE)

Si l’opération réussit, ComPropSheet retourne un handle CPSUI à la page ajoutée ; sinon, elle retourne NULL.

CPSFUNC_DELETE_HCOMPROPSHEET

Le code de la fonction CPSFUNC_DELETE_HCOMPROPSHEET entraîne la suppression par la fonction ComPropSheet d’un ensemble de pages de feuille de propriétés spécifiées par un handle CPSUI.

Paramètres (CPSFUNC_DELETE_HCOMPROPSHEET)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_DELETE_HCOMPROPSHEET lorsqu’il appelle ComPropSheet pour supprimer un ensemble de pages de feuille de propriétés

  • lParam1 : handle CPSUI qui fait référence à l’ensemble de pages à supprimer. Ce handle doit avoir été précédemment obtenu par un appel à ComPropSheet avec l’un des codes de fonction suivants :

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

  • lParam2 : non utilisé, doit être égal à zéro

Valeur de retour (CPSFUNC_DELETE_HCOMPROPSHEET)

La fonction ComPropSheet retourne le nombre de pages de feuille de propriétés qui ont été supprimées.

CPSFUNC_DO_APPLY_CPSUI

Le code de la fonction CPSFUNC_DO_APPLY_CPSUI permet à la fonction ComPropSheet de simuler la remise d’un message de notification PSN_APPLY.

CPSUI répond au code de la fonction CPSFUNC_DO_APPLY_CPSUI en fournissant la raison CPSUICB_REASON_APPLYNOW à la fonction de rappel _CPSUICALLBACK typée d’une application.

Paramètres (CPSFUNC_DO_APPLY_CPSUI)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_DO_APPLY_CPSUI lorsqu’il appelle ComPropSheet pour simuler la remise d’un message de notification PSN_APPLY

  • lParam1 : handle CPSUI qui pointe vers un ensemble d’une ou plusieurs pages de feuille de propriétés. En règle générale, ce handle a été précédemment spécifié en tant que paramètre lParam1 sur ComPropSheet à l’aide du code de fonction CPSFUNC_IGNORE_CPSUI_PSN_APPLY .

  • lParam2 : ce paramètre est une combinaison des indicateurs de bits suivants :

    • APPLYCPSUI_NO_NEWDEF : définissez cet indicateur si vous ne souhaitez pas que les valeurs par défaut actuelles (utilisées pour l’opération Annuler) soient modifiées. Désactivez cet indicateur si vous souhaitez que les valeurs actuelles de toutes les options deviennent les valeurs par défaut utilisées pour l’opération Annuler.

    • APPLYCPSUI_OK_CANCEL_BUTTON : définissez cet indicateur si l’utilisateur a sélectionné le bouton OK ou Annuler (ou si vous souhaitez simuler cette activité). Désactivez cet indicateur si l’utilisateur a sélectionné le bouton Fermer ou Appliquer maintenant (ou si vous souhaitez simuler cette activité). Si votre code est configuré pour recevoir des messages PSN_APPLY, le code doit case activée le membre lParam de la structure PSHNOTIFY. Si le membre est égal à zéro, ce bit doit être effacé.

Valeur de retour (CPSFUNC_DO_APPLY_CPSUI)

Si l’opération réussit, la fonction ComPropSheet retourne une valeur différente de zéro ; sinon, elle retourne zéro et les pages spécifiées deviennent actives.

Si vous utilisez le code de fonction CPSFUNC_IGNORE_CPSUI_PSN_APPLY pour désactiver la gestion par CPSUI du message de notification PSN_APPLY, vous devez utiliser le code de fonction CPSFUNC_DO_APPLY_CPSUI pour simuler la remise du message PSN_APPLY. Sinon, les modifications apportées par l’utilisateur à une page de feuille de propriétés ne peuvent pas être obtenues.

CPSFUNC_GET_HPSUIPAGES

Le code de la fonction CPSFUNC_GET_HPSUIPAGES fait que la fonction ComPropSheet retourne un tableau de handles CPSUI qui pointent vers des pages de feuille de propriétés. Ces handles identifient les pages enfants associées au handle parent de groupe spécifié.

Pour utiliser ce code de fonction, procédez comme suit :

  • Appelez ComPropSheet, en spécifiant le code de fonction CPSFUNC_GET_PAGECOUNT , pour obtenir le nombre de pages enfants associées au parent de groupe spécifié.

  • Allouez suffisamment de mémoire locale pour contenir une structure HANDLE pour chaque page.

  • Appelez à nouveau ComPropSheet , en spécifiant le code de fonction CPSFUNC_GET_HPSUIPAGES et l’adresse de la mémoire allouée localement, pour obtenir un tableau de structures HANDLE.

Paramètres (CPSFUNC_GET_HPSUIPAGES)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction pour CPSFUNC_GET_HPSUIPAGES lorsqu’il appelle ComPropSheet pour récupérer un tableau de handles CPSUI

  • lParam1 : pointeur vers un tableau de structures HANDLE

  • lParam2 : taille du tableau HANDLE pointé vers lParam1

Valeur de retour (CPSFUNC_GET_HPSUIPAGES)

La fonction ComPropSheet retourne le nombre de handles que CPSUI place dans le tableau HANDLE.

CPSFUNC_GET_PAGECOUNT

Le code de la fonction CPSFUNC_GET_PAGECOUNT fait que la fonction ComPropSheet retourne le nombre de pages de feuille de propriétés qui sont des pages enfants du handle parent de groupe spécifié.

Paramètres (CPSFUNC_GET_PAGECOUNT)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_GET_PAGECOUNT lorsqu’il appelle ComPropSheet pour retourner le nombre de pages enfants

  • lParam1 : non utilisé, doit être égal à zéro

  • lParam2 : non utilisé, doit être égal à zéro

Valeur de retour (CPSFUNC_GET_PAGECOUNT)

La fonction ComPropSheet retourne le nombre de pages comptées.

CPSFUNC_GET_PFNPROPSHEETUI_ICON

Le code de fonction CPSFUNC_GET_PFNPROPSHEETUI_ICON fait que la fonction ComPropSheet retourne un handle à l’icône associée à un ensemble de pages de feuille de propriétés. L’ensemble de pages doit avoir été créé précédemment par une fonction de type PFNPROPSHEETUI.

La fonction ComPropSheet appelle la fonction de type PFNPROPSHEETUI associée au handle de page spécifié et transmet une valeur de motif de PROPSHEETUI_REASON_GET_ICON. La fonction de type PFNPROPSHEETUI appelle ensuite LoadImage et fournit la taille d’icône spécifiée bylParam2 pour charger une ressource d’icône.

Paramètres (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_GET_PFNPROPSHEETUI_ICON lorsqu’il appelle ComPropSheet pour récupérer un handle à l’icône associée à un ensemble de pages de feuille de propriétés

  • lParam1 : handle CPSUI qui fait référence à un ensemble de pages de feuille de propriétés. Ce handle doit avoir déjà été obtenu par un appel à ComPropSheet avec le code de fonction CPSFUNC_ADD_PFNPROPSHEETUI .

  • lParam2 : spécifie deux valeurs de taille WORD représentant la taille de l’icône, en pixels. La valeur LOWORD est la largeur et la valeur HIWORD est la hauteur. Si ces valeurs sont égales à zéro, les métriques système SM_CXICON et SM_CYICON sont utilisées. Pour plus d’informations, consultez GetSystemMetrics.

Valeur de retour (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

Si l’opération réussit, la fonction ComPropSheet retourne un handle d’icône ; sinon, il retourne NULL.

CPSFUNC_IGNORE_CPSUI_PSN_APPLY

Le code de la fonction CPSFUNC_IGNORE_CPSUI_PSN_APPLYentraîne la désactivation ou la réactivation de la gestion par CPSUI du message de notification PSN_APPLY .

Le système envoie le message de notification PSN_APPLY à CPSUI lorsqu’un utilisateur sélectionne le bouton OK ou Annuler d’une feuille de propriétés. CPSUI répond à ce message en remettant la raison CPSUICB_REASON_APPLYNOW à la fonction de rappel de type _CPSUICALLBACK d’une application.

Si vous désactivez la gestion par CPSUI du message de notification PSN_APPLY, vous devez utiliser le code de la fonction CPSFUNC_DO_APPLY_CPSUI pour simuler la remise du message PSN_APPLY. Sinon, les modifications apportées par l’utilisateur à une page de feuille de propriétés ne peuvent pas être obtenues.

Si le code de fonction CPSFUNC_IGNORE_CPSUI_PSN_APPLY n’est pas utilisé, la gestion par CPSUI du message de notification PSN_APPLY est activée par défaut.

Paramètres (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_IGNORE_CPSUI_PSN_APPLY lorsqu’il appelle ComPropSheet pour désactiver ou réactiver la gestion par CPSUI du message de notification PSN_APPLY

  • lParam1 : handle CPSUI qui fait référence à un ensemble d’une ou plusieurs pages de feuille de propriétés. Ce handle doit avoir été obtenu précédemment par un appel à ComPropSheet avec un code de fonction de CPSFUNC_ADD_PCOMPROPSHEETUI, ou avec un code de fonction de CPSFUNC_INSERT_PSUIPAGE et un type d’insertion de PSUIPAGEINSERT_PROPSHEETPAGE.

  • lParam2 : toute valeur différente de zéro désactive la remise par CPSUI de la raison CPSUICB_REASON_APPLYNOW . Une valeur zéro permet de réactiver la remise de la raison CPSUICB_REASON_APPLYNOW .

Valeur de retour (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

Si l’opération réussit, la fonction ComPropSheet retourne une valeur différente de zéro ; sinon, il retourne zéro.

CPSFUNC_INSERT_PSUIPAGE

Le code de la fonction CPSFUNC_INSERT_PSUIPAGE permet à la fonction ComPropSheet d’insérer un ensemble de pages de feuille de propriétés à une position spécifique.

Paramètres (CPSFUNC_INSERT_PSUIPAGE)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_INSERT_PSUIPAGE lorsqu’il appelle ComPropSheet pour insérer un ensemble de pages de feuille de propriétés à une position spécifique

  • lParam1 : spécifie un handle pour un ensemble d’une ou plusieurs pages de feuille de propriétés. Les nouvelles pages seront insérées avant ou après ces pages, en fonction du membre Mode de la structure INSERTPSUIPAGE_INFO pointée par lParam2. Ce handle doit avoir déjà été obtenu par un appel à ComPropSheet avec l’un des codes de fonction suivants :

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

  • lParam2 : pointeur vers une structure INSERTPSUIPAGE_INFO , décrivant où et comment les nouvelles pages doivent être insérées

Valeur de retour (CPSFUNC_INSERT_PSUIPAGE)

Si l’opération réussit, la fonction ComPropSheet retourne un handle au jeu de pages qui ont été insérées ; sinon, la fonction retourne NULL.

CPSFUNC_LOAD_CPSUI_ICON

Le code de la fonction CPSFUNC_LOAD_CPSUI_ICON oblige la fonction ComPropSheet à charger une ressource d’icône fournie par CPSUI.

CPSUI appelle LoadImage pour charger la ressource d’icône spécifiée.

Paramètres (CPSFUNC_LOAD_CPSUI_ICON)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_LOAD_CPSUI_ICON lorsqu’il appelle ComPropSheet pour charger une ressource d’icône fournie par CPSUI

  • lParam1 : identificateur de ressource de l’icône fournie par CPSUI à charger. Il doit s’agir d’un identificateur préfixé IDI_CPSUI tel que défini dans Compstui.h.

  • lParam2 : spécifie deux valeurs de taille WORD représentant la taille de l’icône, en pixels. La valeur LOWORD est la largeur et la valeur HIWORD est la hauteur. Si ces valeurs sont égales à zéro, les métriques système SM_CXICON et SM_CYICON sont utilisées. Pour plus d’informations, consultez GetSystemMetrics

Valeur de retour (CPSFUNC_LOAD_CPSUI_ICON)

Si l’opération réussit, la fonction ComPropSheet retourne un handle d’icône ; sinon, il retourne NULL.

CPSFUNC_LOAD_CPSUI_STRING

Le code de la fonction CPSFUNC_LOAD_CPSUI_STRING oblige la fonction ComPropSheet à charger une ressource de chaîne fournie par CPSUI.

La fonction ComPropSheet appelle la fonction LoadString](/windows/win32/api/winuser/nf-winuser-loadstringw) pour charger la chaîne spécifiée.

Paramètres (CPSFUNC_LOAD_CPSUI_STRING)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_LOAD_CPSUI_STRING lorsqu’il appelle ComPropSheet pour charger une ressource de chaîne fournie par CPSUI

  • lParam1 : pointeur de type LPSTR vers une mémoire tampon allouée à l’appelant, dans laquelle la chaîne fournie par CPSUI spécifiée par HIWORD(lParam2) sera placée

  • lParam2 : contient les deux valeurs suivantes fournies par l’appelant :

    • LOWORD(lParam2). Taille, en octets, de la mémoire tampon pointée vers lParam1.

    • HIWORD(lParam2). Identificateur de ressource de la chaîne fournie par CPSUI à charger. Il doit s’agir d’un identificateur préfixé IDS_CPSUI tel que défini dans Compstui.h.

Valeur de retour (CPSFUNC_LOAD_CPSUI_STRING)

Si l’opération réussit, la fonction ComPropSheet retourne la longueur de la chaîne. Si un identificateur de ressource non valide est spécifié, la fonction retourne zéro. Si lParam1 a la valeur NULL ou SI LOWORD(lParam2) a la valeur zéro, la fonction retourne -1.

CPSFUNC_QUERY_DATABLOCK

Le code de la fonction CPSFUNC_QUERY_DATABLOCK permet à la fonction ComPropSheet de récupérer un bloc de données fourni par l’appelant précédemment stocké à l’aide du code de fonction CPSFUNC_SET_DATABLOCK .

En règle générale, ce code de fonction est utilisé par une fonction de rappel de type _CPSUICALLBACK (lorsque la structure CPSUICBPARAM de la fonction contient une valeur Reason de CPSUICB_REASON_SETACTIVE) pour récupérer les valeurs associées à une autre page avant que la page active ne devienne inactive.

Paramètres (CPSFUNC_QUERY_DATABLOCK)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_QUERY_DATABLOCK lorsqu’il appelle ComPropSheet pour récupérer un bloc de données fourni par l’appelant

  • lParam1 : pointeur vers une structure CPSUIDATABLOCK qui identifie la taille et l’emplacement d’une mémoire tampon pour recevoir le bloc de données demandé

  • lParam2 : valeur d’identificateur de taille DWORD, utilisée pour identifier la structure CPSUIDATABLOCK demandée. Cette valeur doit avoir été spécifiée dans un appel précédent à ComPropSheet à l’aide du code de la fonction CPSFUNC_SET_DATABLOCK .

Valeur de retour (CPSFUNC_QUERY_DATABLOCK)

Si l’opération réussit, la fonction ComPropSheet retourne une valeur qui représente la taille du bloc de données récupéré. Si lParam1 a la valeur NULL ou si la valeur d’un membre de la structure CPSUIDATABLOCK fournie est égale à zéro, ComPropSheet retourne la taille requise pour stocker le bloc de données. Si une erreur se produit, la fonction retourne une valeur inférieure ou égale à zéro.

CPSFUNC_SET_DATABLOCK

Le code de la fonction CPSFUNC_SET_DATABLOCK entraîne le stockage par la fonction ComPropSheet d’un bloc de données fourni par l’appelant. Vous pouvez utiliser ce code de fonction pour rendre les informations relatives à une page de feuille de propriétés disponibles pour d’autres pages.

En règle générale, ce code de fonction est utilisé par une fonction de rappel de type _CPSUICALLBACK (lorsque la structure CPSUICBPARAM de la fonction contient une valeur Reason de CPSUICB_REASON_KILLACTIVE) pour enregistrer les valeurs associées à une page avant qu’elle ne devienne inactive.

Paramètres (CPSFUNC_SET_DATABLOCK)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_SET_DATABLOCK lorsqu’il appelle ComPropSheet pour stocker un bloc de données fourni par l’appelant

  • lParam1 : pointeur vers une structure CPSUIDATABLOCK qui décrit le bloc de données à stocker

  • lParam2 : valeur d’identificateur de taille DWORD définie par l’appelant. Il est utilisé pour identifier la structure CPSUIDATABLOCK fournie dans les appels suivants à ComPropSheet à l’aide du code de fonction CPSFUNC_QUERY_DATABLOCK .

Valeur de retour (CPSFUNC_SET_DATABLOCK)

Si l’opération réussit, la fonction ComPropSheet retourne une valeur représentant le nombre d’octets qui ont été stockés ; sinon, elle retourne une valeur inférieure ou égale à zéro.

CPSFUNC_SET_DMPUB_HIDEBITS

Le code de la fonction CPSFUNC_SET_DMPUB_HIDEBITS permet à la fonction ComPropSheet de « masquer » un ensemble spécifié d’options de propriété de document, afin qu’elles ne soient pas affichées.

Vous pouvez utiliser le code de fonction CPSFUNC_SET_DMPUB_HIDEBITS si vous souhaitez définir des structures OPTITEM pour une ou plusieurs options de feuille de propriétés de document, mais vous ne souhaitez pas que les options soient modifiables par l’utilisateur. La page de feuille de propriétés doit être définie à l’aide de la structure COMPROPSHEETUI , et le membre pDlgPage de la structure doit être CPSUI_PDLGPAGE_DOCPROP ou CPSUI_PDLGPAGE_ADVDOCPROP.

Si vous utilisez le code de la fonction CPSFUNC_SET_DMPUB_HIDEBITS , il doit être spécifié dans ComPropSheet avant que le code CPSFUNC_ADD_PCOMPROPSHEETUI ou CPSFUNC_INSERT_PSUIPAGE fonction soit utilisé pour créer la page.

Paramètres (CPSFUNC_SET_DMPUB_HIDEBITS)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_SET_DMPUB_HIDEBITS lorsqu’il appelle ComPropSheet pour « masquer » un ensemble spécifié d’options de propriété de document

  • lParam1 : pointeur vers un tableau de bits qui indique les options à masquer. Ce tableau doit être créé à l’aide de la macro MAKE_DMPUB_HIDEBIT(DMPub), où DMPub est la combinaison OR d’une ou plusieurs constantes préfixées DMPUB_. Les constantes préfixées DMPUB_ sont répertoriées dans la description de la structure OPTITEM . La macro et les constantes sont définies dans Compstui.h.

  • lParam2 : non utilisé, doit être égal à zéro

Valeur de retour (CPSFUNC_SET_DMPUB_HIDEBITS)

Si l’opération réussit, la fonction ComPropSheet retourne la valeur spécifiée pour lParam1 ; sinon, elle retourne zéro.

CPSFUNC_SET_FUSION_CONTEXT

Le CPSFUNC_SET_FUSION_CONTEXT définit un contexte d’activation Fusion pour la page spécifiée.

Lorsqu’une page est sur le point d’être créée ou insérée et qu’elle ne spécifie pas de contexte d’activation dans sa structure PROPSHEETPAGE , elle est créée dans le contexte d’activation de la page parente.

Si le contexte d’activation du parent n’est pas défini, Compstui.dll recherche le parent du parent, en continuant jusqu’à ce que le parent de niveau supérieur soit atteint ou jusqu’à ce qu’il trouve un parent avec un contexte d’activation correctement défini.

Si aucun des parents n’a de contexte d’activation défini, Compstui.dll ne spécifie pas de contexte d’activation dans la structure PROPSHEETPAGE . Cela signifie que la page sera créée dans le contexte d’activation de l’appelant de la fonction PropertySheet .

Paramètres (CPSFUNC_SET_FUSION_CONTEXT)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_SET_FUSION_CONTEXT lorsqu’il appelle ComPropSheet pour définir un contexte d’activation Fusion pour la page spécifiée

  • lParam1 : spécifie le handle du contexte Fusion. Compstui.dll duplique le handle en l’attachant à ses structures internes, de sorte que l’appelant n’est pas obligé de conserver le handle. Compstui.dll libère le handle de contexte passé lorsque le handle de Compstui.dll est supprimé.

  • lParam2 : non utilisé, doit être égal à zéro

Valeur de retour (CPSFUNC_SET_FUSION_CONTEXT)

Si l’opération réussit, la fonction ComPropSheet retourne une valeur supérieure à zéro. Sinon, ComPropSheet retourne une valeur inférieure ou égale à zéro. Pour plus d’informations sur l’erreur, utilisez la fonction GetLastError .

CPSFUNC_SET_HSTARTPAGE

Le code de la fonction CPSFUNC_SET_HSTARTPAGE fait en sorte que la fonction ComPropSheet marque une page de feuille de propriétés spécifiée comme la page supérieure de la feuille de propriétés associée. Si la feuille de propriétés est en cours d’affichage, la page spécifiée devient la page active.

Paramètres (CPSFUNC_SET_HSTARTPAGE)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_SET_HSTARTPAGE lorsqu’il appelle ComPropSheet pour marquer une page de feuille de propriétés spécifiée comme page supérieure de la feuille de propriétés associée

  • lParam1 : handle de page CPSUI fourni par l’appelant, précédemment obtenu par un appel à ComPropSheet avec l’un des codes de fonction suivants :

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PCOMPROPSHEETUI

    • CPSFUNC_ADD_PFNPROPSHEETUI

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE

    Si le handle représente une seule page appartenant au groupe spécifié par hComPropSheet, CPSUI fait de cette page la page supérieure.

    Si le handle représente un handle parent de groupe (voir CPSFUNC_INSERT_PSUIPAGE), lParam2 représente un index de base zéro dans les pages du groupe et la page représentée par l’index devient la page supérieure.

  • lParam2 : si lParam1 représente un handle parent de groupe, cette valeur fournie par l’appelant est un index de base zéro dans les pages du groupe. Si lParam1 représente une seule page appartenant au groupe spécifié par hComPropSheet, ce paramètre n’est pas utilisé. Si le handle spécifié par lParam1 a été obtenu à l’aide du code de fonction CPSFUNC_ADD_PCOMPROPSHEETUI et si le membre pDlgPage de la structure COMPROPSHEETUI associée a la valeur CPSUI_PDLGPAGE_DOCPROP, l’une des valeurs suivantes peut être spécifiée pour lParam2 :

    • SSP_STDPAGE1 : faites de la page Mise en page la page supérieure.

    • SSP_STDPAGE2 : faites de la page Papier/Qualité la page du haut.

    • SSP_TVPAGE : faites de la page Avancé la page supérieure.

Valeur de retour (CPSFUNC_SET_HSTARTPAGE)

Si l’opération réussit, la fonction ComPropSheet retourne la valeur spécifiée pour lParam1 ; sinon, elle retourne zéro.

CPSFUNC_SET_PSUIPAGE_ICON

Le code de la fonction CPSFUNC_SET_PSUIPAGE_ICON amène la fonction ComPropSheet à ajouter, remplacer ou supprimer l’icône affectée à l’onglet d’une page de feuille de propriétés.

Si lParam2 contient un handle d’icône et si la page spécifiée par lParam1 est en cours d’affichage, CPSUI ajoute l’icône à l’onglet de la page spécifiée. Si une icône est déjà affectée à la page, l’ancienne icône est remplacée par la nouvelle. Si lParam2 est égal à zéro, l’icône actuelle (le cas échéant) est supprimée.

Pour toutes les icônes spécifiées avec le code de fonction CPSFUNC_SET_PSUIPAGE_ICON , CPSUI définit la taille de l’image sur 16 par 16 pixels.

Les descripteurs d’icône doivent être obtenus en appelant LoadImage.

Paramètres (CPSFUNC_SET_PSUIPAGE_ICON)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_SET_PSUIPAGE_ICON lorsqu’il appelle ComPropSheet pour ajouter, remplacer ou supprimer l’icône affectée à l’onglet d’une page de feuille de propriétés

  • lParam1 : handle de page CPSUI fourni par l’appelant, précédemment obtenu par un appel à ComPropSheet avec l’un des codes de fonction suivants :

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE (avec le membre Type de la structure INSERTPSUIPAGE_INFO défini sur PSUIPAGEINSERT_HPROPSHEETPAGE ou PSUIPAGEINSERT_PROPSHEETPAGE)

  • lParam2 : handle d’icône fourni par l’appelant. Vous pouvez définir ce paramètre sur zéro pour supprimer l’icône actuelle

Valeur de retour (CPSFUNC_SET_PSUIPAGE_ICON)

Si l’opération réussit, la fonction ComPropSheet retourne 1. Si une erreur est rencontrée ou si la page spécifiée n’est pas actuellement affichée, la fonction retourne zéro.

CPSFUNC_SET_PSUIPAGE_TITLE

Le code de la fonction CPSFUNC_SET_PSUIPAGE_TITLE permet à la fonction ComPropSheet de définir le titre de l’onglet d’une page de feuille de propriétés.

Paramètres (CPSFUNC_SET_PSUIPAGE_TITLE)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_SET_PSUIPAGE_TITLE lorsqu’il appelle ComPropSheet pour définir le titre de l’onglet d’une page de feuille de propriétés

  • lParam1 : handle de page CPSUI fourni par l’appelant, précédemment obtenu par un appel à ComPropSheet avec l’un des codes de fonction suivants :

    • CPSFUNC_ADD_HPROPSHEETPAGE

    • CPSFUNC_ADD_PROPSHEETPAGE

    • CPSFUNC_INSERT_PSUIPAGE (avec le membre Type de la structure INSERTPSUIPAGE_INFO défini sur PSUIPAGEINSERT_HPROPSHEETPAGE ou PSUIPAGEINSERT_PROPSHEETPAGE).

  • lParam2 : pointeur fourni par l’appelant vers une chaîne terminée par NULL qui spécifie le nouveau titre

Valeur de retour (CPSFUNC_SET_PSUIPAGE_TITLE)

Si l’opération réussit, la fonction ComPropSheet retourne 1. Si une erreur est rencontrée ou si la page spécifiée n’est pas affichée, la fonction retourne zéro.

CPSFUNC_SET_RESULT

Le code de la fonction CPSFUNC_SET_RESULT fait passer à la fonction ComPropSheet une valeur de résultat spécifiée à toutes les fonctions de type PFNPROPSHEETUI associées à une page spécifiée et à ses parents.

Pour plus d’informations sur la définition des valeurs de résultat, consultez la description de la structure SETRESULT_INFO .

La mise en garde suivante s’applique au plug-in D’interface utilisateur IHV basé sur Unidrv ou Pscript5 avec des feuilles de propriétés d’interface utilisateur personnalisées, et pour lesquels les paramètres utilisateur définis dans les feuilles de propriétés doivent être persistants. Lorsque le plug-in appelle la fonction ComPropSheet avec le paramètre Function défini sur CPSFUNC_SET_RESULT, le plug-in doit définir le paramètre lParam2 sur CPSUI_OK.

Paramètres (CPSFUNC_SET_RESULT)

  • hComPropSheet : handle parent de groupe

  • Fonction : l’appelant définit ce paramètre de code de fonction sur CPSFUNC_SET_RESULT lorsqu’il appelle ComPropSheet pour passer une valeur de résultat spécifiée à toutes les fonctions de type PFNPROPSHEETUI associées à une page spécifiée et à ses parents.

  • lParam1 : handle CPSUI fourni par l’appelant à la page pour laquelle une valeur de résultat est passée. Si lParam1 a la valeur NULL, le CPSUI utilise la valeur spécifiée par hComPropSheet.

  • lParam2 : valeur de résultat DWORD 32 bits fournie par l’appelant.

Valeur de retour (CPSFUNC_SET_RESULT)

Si l’opération réussit, la fonction ComPropSheet retourne le nombre de fonctions de type PFNPROPSHEETUI appelées. Si le handle spécifié pour lParam1 n’est pas valide, la fonction retourne -1.

Configuration requise

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