STRUCTURE COMPROPSHEETUI (compstui.h)

Article
02/06/2025

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 l'pfnCallback membre 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 About. (CPSUI fournit un bouton À propos de pour chaque nœud racine treeview.)

CPSUIF_ICONID_AS_HICON

Si elle est définie, le membre IconID de la structure contient un handle d’icône.

Si ce n’est pas le cas, le IconID membre contient un identificateur de ressource d’icône.

CPSUIF_UPDATE_PERMISSION

Si elle est définie, les valeurs d’option de la page peuvent être modifiées par l’utilisateur.

hInstCaller

Handle d’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, qui place CPSUI dans un cpSUICBPARAM membre UserData 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 d’accès au 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 _CPSUICALLBACK-typée, qui appelle CPSUI lorsqu’un utilisateur modifie les valeurs d’option de la page.

Ne peut être utilisé que si pDlgPage identifie une structure DLG PAGE 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 structures DLGPAGE qui décrivent les pages à ajouter à la feuille de propriétés. Il peut s’agir de l’une des options 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 lit avancé . Pour une utilisation uniquement par une fonction DrvDocumentPropertySheets.
- CPSUI_PDLGPAGE_DOCPROP
  
  Définit trois pages, dont les onglets sont De disposition, Papier/Qualitéet Avancé . La page Advanced est une arborescence. Pour une utilisation uniquement par une fonction DrvDocumentPropertySheets.
- CPSUI_PDLGPAGE_PRINTERPROP
  
  Définit une page treeview dont l’onglet lit Paramètres de l’appareil. Pour une utilisation uniquement par une fonction DrvDevicePropertySheets.
- CPSUI_PDLGPAGE_TREEVIEWONLY
  
  Définit une page treeview.

cOptItem

Numéro fourni par l’appelant de structures OPTITEM pointées par pOptItem.

cDlgPage

Numéro fourni par l’appelant structures DLGPAGE pointées par pDlgPage. Non utilisé si pDlgPage spécifie une structure prédéfini CPSUI_PDLGPAGE préfixée.

IconID

L’appelant peut être l’un des éléments suivants :

Identificateur de ressource d’icône. Cela peut être défini par l’application, ou il peut s’agir de l’un des identificateurs de ressource d’icônes IDI_CPSUI préfixés de cpSUI.
Handle d’icône. Si un handle est spécifié, CPSUIF_ICONID_AS_HICON doit être défini dans le membre Flags.

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 d’appareil 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 un numéro de version de l’appelant 3.16. Le numéro de version s’affiche lorsqu’un utilisateur clique sur le bouton À propos de 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, cela représente généralement une version d’appareil 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 de l’appelant 3.255. Le numéro de version s’affiche lorsqu’un utilisateur clique sur le bouton À propos de d’une page.

dwReserved[4]

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

Exigences

Exigence	Valeur
d’en-tête	compstui.h (include Compstui.h)

Partager via