OEMCUIPPARAM-Struktur (printoem.h)

Artikel
08/07/2023

Die OEMCUIPPARAM-Struktur wird als Eingabeparameter für die IPrintOemUI::CommonUIProp-Methode eines Benutzeroberfläche-Plug-Ins verwendet.

Syntax

typedef struct _OEMCUIPPARAM {
  DWORD           cbSize;
  POEMUIOBJ       poemuiobj;
  HANDLE          hPrinter;
  PWSTR           pPrinterName;
  HANDLE          hModule;
  HANDLE          hOEMHeap;
  PDEVMODE        pPublicDM;
  PVOID           pOEMDM;
  DWORD           dwFlags;
  POPTITEM        pDrvOptItems;
  DWORD           cDrvOptItems;
  POPTITEM        pOEMOptItems;
  DWORD           cOEMOptItems;
  PVOID           pOEMUserData;
  OEMCUIPCALLBACK OEMCUIPCallback;
} *POEMCUIPPARAM, OEMCUIPPARAM;

Member

cbSize

Größe der OEMCUIPPARAM-Struktur . Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

poemuiobj

Zeiger auf eine OEMUIOBJ-Struktur .

hPrinter

Handle mit dem Drucker. Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

pPrinterName

Zeichenfolge, die den Druckernamen enthält. Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

hModule

Handle mit dem Benutzeroberflächen-Plug-In. Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

hOEMHeap

Behandeln Sie einen Heap, aus dem Speicherplatz zugewiesen werden kann, indem Sie die HeapAlloc-Funktion aufrufen (in der Microsoft Windows SDK-Dokumentation beschrieben). Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

pPublicDM

Zeiger auf die öffentliche DEVMODEW-Struktur des Druckers. Gültig nur, wenn das dwMode-Argument der IPrintOemUI::CommonUIProp-Methode OEMCUIP_DOCPROP ist. Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

pOEMDM

Zeiger auf die privaten DEVMODEW-Member des Benutzeroberfläche-Plug-Ins. Gültig nur, wenn das dwMode-Argument der IPrintOemUI::CommonUIProp-Methode OEMCUIP_DOCPROP ist. Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

dwFlags

Für Aufrufe von IPrintOemUI::CommonUIProp mit dem dwMode-Parameter, der auf OEMCUIP_DOCPROP

Enthält den Inhalt des fMode-Members der DOCUMENTPROPERTYHEADER-Struktur , die von der DrvDocumentPropertySheets-Funktion des Druckertreibers empfangen wird.

Für Aufrufe von IPrintOemUI::CommonUIProp mit dem dwMode-Parameter, der auf OEMCUIP_PRNPROP

Enthält den Inhalt des Flags-Members der DEVICEPROPERTYHEADER-Struktur, die von der DrvDevicePropertySheets-Funktion des Druckertreibers empfangen wird.

pDrvOptItems

Zeiger auf das OPTITEM-Array des Druckertreibers. Ungültig beim ersten Aufruf von IPrintOemUI::CommonUIProp . Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

cDrvOptItems

Anzahl der OPTITEM-Strukturen im Array, auf das von pDrvOptItems verwiesen wird. Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

pOEMOptItems

Zeiger auf ein Array von OPTITEM-Strukturen . Wird vom IPrintOemUI::CommonUIProp-Aufrufer bereitgestellt. Beim zweiten Aufruf der IPrintOemUI::CommonUIProp-Methode müssen OPTITEM-Strukturen , die vom Benutzeroberflächen-Plug-In definiert werden, in diesem Array platziert werden, und die Strukturanzahl muss in cOEMOptItems platziert werden. Für jede OPTITEM-Struktur, die im Array platziert ist, müssen Sie die folgenden Schritte ausführen:

Legen Sie den DMPubID-Member der OPTITEM-Struktur entweder auf einen der vordefinierten Werte oder auf einen Wert fest, der größer als DMPUB_USER ist. Wenn Sie vordefinierte Werte verwenden, müssen Sie das gesamte OPTITEM-Array nach Strukturen durchsuchen, die diese Werte bereits enthalten, und Sie müssen deren OPTIF_HIDE-Flags festlegen.
Weisen Sie Speicherplatz für OPTTYPES - und OPTPARAMS-Strukturen zu, indem Sie die Windows SDK-Funktion HeapAlloc mithilfe des Handles aufrufen, der im hOEMHeap-Member der OEMCUIPPARAM-Struktur enthalten ist. Der Druckertreiber verteilt diesen Speicherplatz, wenn er nicht mehr benötigt wird.

Ungültig beim ersten Aufruf von IPrintOemUI::CommonUIProp .

cOEMOptItems

Anzahl der OPTITEM-Strukturen, die im Array enthalten sind, auf das von pOEMOptItems verwiesen wird. Wird vom Unidrv- oder Pscript5-Treiber bereitgestellt.

Wenn die IPrintOemUI::CommonUIProp-Methode zum ersten Mal aufgerufen wird, ist der vom Aufrufer bereitgestellte Wert für cOEMOptItems 0. Die IPrintOemUI::CommonUIProp-Methode muss diesen Wert ändern, um die Anzahl von OPTITEM-Strukturen anzugeben, die die Methode bereitstellt. Beim zweiten Aufruf muss IPrintOemUI::CommonUIProp die Anzahl der OPTITEM-Strukturen angeben, die tatsächlich dem Array hinzugefügt wurden, auf das pOEMOptItems verweist.

pOEMUserData

Wird von der IPrintOemUI::CommonUIProp-Methode beim zweiten Aufruf verwendet, um die OEMCUIPCallback-Funktion mit optionalen zusätzlichen Eingabeinformationen bereitzustellen.

OEMCUIPCallback

Wird von der IPrintOemUI::CommonUIProp-Methode beim zweiten Aufruf verwendet, um die Adresse einer Rückruffunktion vom Typ OEMCUIPCALLBACK zurückzugeben.

Hinweise

Ein Benutzeroberflächen-Plug-In empfängt die Adresse dieser Struktur als Eingabeargument sowohl für die IPrintOemUI::CommonUIProp-Methode als auch für die vom OEMCUIPCALLBACK-typisierte Rückruffunktion.

Weitere Informationen zur Verwendung dieser Struktur und der zugehörigen Funktionen finden Sie unter Benutzeroberflächen-Plug-Ins.

Anforderungen

Anforderung	Wert
Header	printoem.h (include Printoem.h)

Freigeben über