Structure COMPROPSHEETUI (compstui.h)

La structure COMPROPSHEETUI est utilisée comme paramètre d’entrée pour la fonction ComPropSheet de CPSUI, si le code de la fonction est CPSFUNC_ADD_PCOMPROPSHEETUI. Tous les membres de structure doivent être fournis par l’appelant de ComPropSheet.

Syntaxe

typedef struct _COMPROPSHEETUI {
  WORD           cbSize;
  WORD           Flags;
  HINSTANCE      hInstCaller;
  LPTSTR         pCallerName;
  ULONG_PTR      UserData;
  LPTSTR         pHelpFile;
  _CPSUICALLBACK pfnCallBack;
  POPTITEM       pOptItem;
  PDLGPAGE       pDlgPage;
  WORD           cOptItem;
  WORD           cDlgPage;
  ULONG_PTR      IconID;
  LPTSTR         pOptItemName;
  WORD           CallerVersion;
  WORD           OptItemVersion;
  ULONG_PTR      dwReserved[4];
} COMPROPSHEETUI, *PCOMPROPSHEETUI;

Membres

cbSize

Taille fournie par l’appelant, en octets, de la structure COMPROPSHEETUI .

Flags

Indicateurs de bits facultatifs fournis par l’appelant, comme décrit dans la liste suivante :

CPSUIF_ABOUT_CALLBACK

Si elle est définie, la fonction de rappel de la page (pointée par le membre pfnCallback de la structure) prend en charge CPSUICB_REASON_ABOUT, de sorte que CPSUI appelle la fonction de rappel si l’utilisateur clique sur le bouton À propos de la page. (CPSUI fournit un bouton À propos de pour chaque nœud racine treeview.)

CPSUIF_ICONID_AS_HICON

S’il est défini, le membre IconID de la structure contient un handle d’icône.

S’il n’est pas défini, le membre IconID contient un identificateur de ressource d’icône.

CPSUIF_UPDATE_PERMISSION

Si elles sont définies, les valeurs d’option de la page peuvent être modifiées par l’utilisateur.

hInstCaller

Handle de instance de module fourni par l’appelant, reçu par la fonction de point d’entrée de la DLL.

pCallerName

Pointeur fourni par l’appelant vers une chaîne de texte terminée par null représentant le nom de l’application. (Pour une DLL d’interface d’imprimante, il doit s’agir du nom du pilote, tel que « Pilote PostScript ».)

UserData

Valeur facultative fournie par l’appelant, que CPSUI place dans le membre UserData d’une structure CPSUICBPARAM lors de l’appel de la fonction pointée par pfnCallBack.

pHelpFile

Pointeur fourni par l’appelant vers une chaîne de texte terminée par NULL représentant un chemin d’accès à un fichier d’aide. Pour les DLL d’interface d’imprimante, il s’agit généralement du chemin du fichier d’aide obtenu en appelant GetPrinterDriver.

Le fichier d’aide est indexé par les valeurs contenues dans le membre HelpIndex des structures OPTITEM .

pfnCallBack

Pointeur fourni par l’appelant vers une fonction de rappel de type _CPSUICALLBACK, que CPSUI appelle lorsqu’un utilisateur modifie les valeurs d’option de la page.

Peut être utilisé uniquement si pDlgPage identifie une structure DLGPAGE fournie par CPSUI, ou si le membre DlgProc d’une structure DLGPAGE fournie par l’application est NULL.

pOptItem

Pointeur fourni par l’appelant vers un tableau de structures OPTITEM décrivant les options de la page.

pDlgPage

Ce membre spécifie les structures DLGPAGE qui décrivent les pages à ajouter à la feuille de propriétés. Il peut s'agir de l'une des valeurs suivantes :

• Pointeur vers un tableau de structures DLGPAGE.

• Un des pointeurs décrits dans la liste suivante. Ces pointeurs font référence à des structures DLGPAGE prédéfinies, fournies par CPSUI pour une utilisation par des DLL d’interface d’imprimante.

  • CPSUI_PDLGPAGE_ADVDOCPROP

    Définit une page treeview dont l’onglet indique Avancé. Pour une utilisation uniquement par une fonction DrvDocumentPropertySheets .

  • CPSUI_PDLGPAGE_DOCPROP

    Définit trois pages, dont les onglets sont Disposition, Papier/Qualité et Avancé. La page Avancé est une arborescence. Pour une utilisation uniquement par une fonction DrvDocumentPropertySheets .

  • CPSUI_PDLGPAGE_PRINTERPROP

    Définit une page treeview dont l’onglet indique Paramètres de l’appareil. Pour une utilisation uniquement par une fonction DrvDevicePropertySheets .

  • CPSUI_PDLGPAGE_TREEVIEWONLY

    Définit une page treeview.

cOptItem

Nombre de structures OPTITEM fournies par l’appelant pointées par pOptItem.

cDlgPage

Nombre de structures DLGPAGE fournies par l’appelant pointées par pDlgPage. Non utilisé si pDlgPage spécifie une structure prédéfinie avec préfixe CPSUI_PDLGPAGE.

IconID

Fourni par l’appelant, peut être l’un des éléments suivants :

• Identificateur de ressource d’icône. Il peut s’agir de l’un des identificateurs de ressource d’icône avec préfixe IDI_CPSUI fournis par CPSUI.

• Handle d’icône. Si un handle est spécifié, CPSUIF_ICONID_AS_HICON doit être défini dans le membre Indicateurs .

L’icône spécifiée s’affiche dans le nœud racine de l’arborescence de la page de feuille de propriétés.

pOptItemName

Pointeur fourni par l’appelant vers une chaîne terminée par NULL à afficher dans le nœud racine de l’arborescence de la page de feuille de propriétés. Pour les DLL d’interface d’imprimante, cette chaîne représente généralement un type de périphérique d’imprimante, tel que « HP 4si ».

CallerVersion

Numéro de version fourni par l’appelant, représentant la version actuelle de l’application appelante. L’octet élevé identifie la version principale, et l’octet faible est la version mineure. Par exemple, une valeur CallerVersion de 0x310 spécifie le numéro de version de l’appelant 3.16. Le numéro de version s’affiche lorsqu’un utilisateur clique sur le bouton À propos d’une page.

OptItemVersion

Numéro de version fourni par l’appelant, représentant la version actuelle de l’élément d’option de niveau racine. Pour les DLL d’interface d’imprimante, il s’agit généralement d’une version de périphérique d’imprimante. L’octet élevé identifie la version principale, et l’octet faible est la version mineure. Par exemple, une valeur OptItemVersion de 0x3ff spécifie un numéro de version d’appelant de 3,255. Le numéro de version s’affiche lorsqu’un utilisateur clique sur le bouton À propos d’une page.

dwReserved[4]

Réservé. Ce tableau doit être défini sur zéro.

Configuration requise

Condition requise	Valeur
En-tête	compstui.h (inclure Compstui.h)