COMPROPSHEETUI-Struktur (compstui.h)

Artikel
08/07/2023

Die COMPROPSHEETUI-Struktur wird als Eingabeparameter für die ComPropSheet-Funktion von CPSUI verwendet, wenn der Funktionscode CPSFUNC_ADD_PCOMPROPSHEETUI ist. Alle Strukturmember müssen vom Aufrufer von ComPropSheet bereitgestellt werden.

Syntax

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;

Member

cbSize

Vom Aufrufer bereitgestellte Größe der COMPROPSHEETUI-Struktur in Byte.

Flags

Optionale vom Aufrufer bereitgestellte Bitflags, wie in der folgenden Liste beschrieben:

CPSUIF_ABOUT_CALLBACK

Falls festgelegt, unterstützt die Rückruffunktion der Seite (auf die vom pfnCallback-Element der Struktur verwiesen wird) CPSUICB_REASON_ABOUT, sodass CPSUI die Rückruffunktion aufruft, wenn der Benutzer auf die Schaltfläche Info der Seite klickt. (CPSUI stellt eine Info-Schaltfläche für jeden Treeview-Stammknoten bereit.)

CPSUIF_ICONID_AS_HICON

Wenn festgelegt, enthält das IconID-Element der Struktur ein Symbolhandle.

Wenn nicht festgelegt, enthält das IconID-Element einen Symbolressourcenbezeichner.

CPSUIF_UPDATE_PERMISSION

Falls festgelegt, können die Optionswerte der Seite vom Benutzer geändert werden.

hInstCaller

Das vom Aufrufer bereitgestellte Modul instance Handle, das von der Einstiegspunktfunktion der DLL empfangen wird.

pCallerName

Vom Aufrufer bereitgestellter Zeiger auf eine MIT NULL beendete Textzeichenfolge, die den Namen der Anwendung darstellt. (Bei einer Druckerschnittstellen-DLL sollte dies der Name des Treibers sein, z. B. "PostScript-Treiber".)

UserData

Optionaler vom Aufrufer bereitgestellter Wert, den CPSUI im UserData-Member einer CPSUICBPARAM-Struktur platziert, wenn die Funktion aufgerufen wird, auf die pfnCallBack verweist.

pHelpFile

Vom Aufrufer bereitgestellter Zeiger auf eine MIT NULL beendete Textzeichenfolge, die einen Pfad zu einer Hilfedatei darstellt. Bei Druckerschnittstellen-DLLs ist dies in der Regel der Hilfedateipfad, der durch Aufrufen von GetPrinterDriver abgerufen wird.

Die Hilfedatei wird anhand von Werten indiziert, die im HelpIndex-Member von OPTITEM-Strukturen enthalten sind.

pfnCallBack

Vom Aufrufer bereitgestellter Zeiger auf eine _CPSUICALLBACK typisierte Rückruffunktion, die CPSUI aufruft, wenn ein Benutzer die Optionswerte der Seite ändert.

Kann nur verwendet werden, wenn pDlgPage eine von CPSUI bereitgestellte DLGPAGE-Struktur identifiziert oder wenn das DlgProc-Element einer von der Anwendung bereitgestellten DLGPAGE-Struktur NULL ist.

pOptItem

Vom Aufrufer bereitgestellter Zeiger auf ein Array von OPTITEM-Strukturen , die die Optionen der Seite beschreiben.

pDlgPage

Dieser Member gibt DLGPAGE-Strukturen an, die Seiten beschreiben, die dem Eigenschaftenblatt hinzugefügt werden sollen. Folgende Optionen sind möglich:

Ein Zeiger auf ein Array von DLGPAGE-Strukturen.
Einer der In der folgenden Liste beschriebenen Zeiger. Diese Zeiger verweisen auf vordefinierte DLGPAGE-Strukturen, die von CPSUI zur Verwendung durch Druckerschnittstellen-DLLs bereitgestellt werden.
- CPSUI_PDLGPAGE_ADVDOCPROP
  
  Definiert eine Treeview-Seite, deren Registerkarte Erweitert lautet. Nur für die Verwendung durch eine DrvDocumentPropertySheets-Funktion .
- CPSUI_PDLGPAGE_DOCPROP
  
  Definiert drei Seiten, deren Registerkarten Layout, Paper/Quality und Advanced sind. Die Seite Erweitert ist eine Treeview. Nur für die Verwendung durch eine DrvDocumentPropertySheets-Funktion .
- CPSUI_PDLGPAGE_PRINTERPROP
  
  Definiert eine Treeview-Seite, auf deren Registerkarte Geräteeinstellungen angezeigt werden. Nur für die Verwendung durch eine DrvDevicePropertySheets-Funktion .
- CPSUI_PDLGPAGE_TREEVIEWONLY
  
  Definiert eine Treeview-Seite.

cOptItem

Vom Aufrufer bereitgestellte Anzahl von OPTITEM-Strukturen , auf die von pOptItem verwiesen wird.

cDlgPage

Vom Aufrufer bereitgestellte Anzahl von DLGPAGE-Strukturen , auf die von pDlgPage verwiesen wird. Wird nicht verwendet, wenn pDlgPage eine vordefinierte CPSUI_PDLGPAGE Struktur mit Präfix angibt.

IconID

Vom Aufrufer bereitgestellt, kann einer der folgenden Sein:

Ein Symbolressourcenbezeichner. Dies kann von der Anwendung definiert sein, oder es kann sich um eine der von CPSUI bereitgestellten Ressourcen-IDs mit IDI_CPSUI Symbol-Präfix sein.
Ein Symbolhandle. Wenn ein Handle angegeben wird, muss CPSUIF_ICONID_AS_HICON im Flags-Element festgelegt werden.

Das angegebene Symbol wird im Stammknoten der Strukturansicht der Eigenschaftenblattseite angezeigt.

pOptItemName

Vom Aufrufer bereitgestellter Zeiger auf eine NULL-beendete Zeichenfolge, die im Stammknoten der Strukturansicht der Eigenschaftenblattseite angezeigt werden soll. Bei Druckerschnittstellen-DLLs stellt diese Zeichenfolge in der Regel einen Druckergerätetyp dar, z. B. "HP 4si".

CallerVersion

Vom Aufrufer bereitgestellte Versionsnummer, die die aktuelle Version der aufrufenden Anwendung darstellt. Das hohe Byte identifiziert die Hauptversion, und das niedrige Byte ist die Nebenversion. Beispielsweise gibt der CallerVersion-Wert von 0x310 die Versionsnummer des Aufrufers 3.16 an. Die Versionsnummer wird angezeigt, wenn ein Benutzer auf die Schaltfläche Info einer Seite klickt.

OptItemVersion

Vom Aufrufer bereitgestellte Versionsnummer, die die aktuelle Version des Optionselements auf Stammebene darstellt. Bei Druckerschnittstellen-DLLs stellt dies in der Regel eine Druckergeräteversion dar. Das hohe Byte identifiziert die Hauptversion, und das niedrige Byte ist die Nebenversion. Beispielsweise gibt ein OptItemVersion-Wert von 0x3ff die Aufruferversionsnummer 3.255 an. Die Versionsnummer wird angezeigt, wenn ein Benutzer auf die Schaltfläche Info einer Seite klickt.

dwReserved[4]

Reserviert. Dieses Array muss auf 0 (null) festgelegt werden.

Anforderungen

Anforderung	Wert
Header	compstui.h (include Compstui.h)

Freigeben über