IPrintOemUI::CommonUIProp-Methode (prcomoem.h)

Artikel
02/07/2025

Mit der IPrintOemUI::CommonUIProp-Methode kann ein Benutzeroberflächen-Plug-In eine vorhandene Blattseite für Druckereigenschaften ändern.

Syntax

HRESULT CommonUIProp(
  DWORD         dwMode,
  POEMCUIPPARAM pOemCUIPParam
);

Parameter

dwMode

Vom Aufrufer bereitgestellte ganzzahlige Konstante, die angibt, welche Eigenschaftenblattseite geändert werden soll. Die folgenden Konstanten sind gültig.

Wert	Definition
OEMCUIP_DOCPROP	Die Methode wird aufgerufen, um die Seite "Layout", "Papier/Qualität" oder "Erweitert" des Dokumenteigenschaftenblatts zu ändern.
OEMCUIP_PRNPROP	Die Methode wird aufgerufen, um die Seite "Geräteeinstellungen" des Blatts "Druckereigenschaften" zu ändern.

pOemCUIPParam

Vom Aufrufer bereitgestellter Zeiger auf eine OEMCUIPPARAM- Struktur.

Rückgabewert

Die Methode muss einen der folgenden Werte zurückgeben.

Rückgabecode	Beschreibung
S_OK	Der Vorgang war erfolgreich.
E_FAIL	Fehler beim Vorgang.
E_NOTIMPL	Die Methode ist nicht implementiert.

Bemerkungen

Wenn die IPrintOemUI::CommonUIProp-Methode eines Benutzeroberflächen-Plug-Ins aufgerufen wird, sollte es angepasste Eigenschaftenblattoptionselemente zurückgeben, um eine vorhandene Druckereigenschaftsblattseite zu ändern.

Die IPrintOemUI::CommonUIProp-Methode wird von der Druckerschnittstelle DLL-des Druckertreibers aufgerufen. Die Methode sollte ein Array von OPTITEM- Strukturen bereitstellen, die Eigenschaftenblattelemente beschreiben, sowie eine Rückruffunktion zur Verarbeitung von Benutzeränderungen an Optionswerten.

Sie sollten davon ausgehen, dass die Methode für jedes Eigenschaftenblatt zweimal aufgerufen wird. Der dwMode Parameterwert der Methode gibt an, ob der Parameterwert aufgerufen wird, um Änderungen am Blatt der Druckereigenschaft oder am Dokumenteigenschaftenblatt vorzunehmen.

Wenn sie zum ersten Mal aufgerufen wird, sollte die Methode nur die Anzahl der hinzuzufügenden OPTITEM- Strukturen zurückgeben. Diese Zahl sollte im OEMCUIPPARAM-cOEMOptItems Mitglied der Struktur platziert werden. Die Druckerschnittstellen-DLL weist dann genügend Arbeitsspeicher zu, um die angegebene Anzahl von OPTITEMs zu speichern, und ruft IPrintOemUI::CommonUIProp erneut auf.

Wenn sie zum zweiten Mal aufgerufen wird, sollte die IPrintOemUI::CommonUIProp-Methode folgendes ausführen:

Füllen Sie das vom Treiber gelieferte Array von OPTITEM-Strukturen mit Optionsbeschreibungen aus. Dieses Array verweist auf die pOEMOptItems Member der OEMCUIPPARAM-Struktur, und die Anzahl der zugeordneten Arrayelemente ist in den cOEMOptItems Member der Struktur enthalten. (Informationen zum Angeben von OPTITEM-Memberwerten finden Sie in der Beschreibung der pOEMOptItems Member der OEMCUIPPARAM-Struktur).
Gibt die Anzahl der Strukturen zurück, die dem OPTITEM-Array hinzugefügt werden, indem die Zahl in der cOEMOptItems- Member der OEMCUIPPARAM-Struktur platziert wird.
Gibt die Adresse einer Rückruffunktion in der OEMCUIPCallback Member der OEMCUIPPARAM-Struktur zurück. Diese Rückruffunktion wird aufgerufen, wenn ein Benutzer die Eigenschaftenblattseite ändert. Die Rückruffunktion muss vom Typ OEMCUIPCALLBACK-sein.
Geben Sie optional die Adresse einer privaten Datenstruktur zurück, indem Sie sie in der pOEMUserData Member der OEMCUIPPARAM-Struktur platzieren. Die durch die OEMCUIPCallback Member der Struktur angegebene Rückruffunktion empfängt die Adresse der OEMCUIPPARAM-Struktur als Eingabeparameter und kann daher die Adresse der privaten Daten abrufen.
Speicherplatz für die private Datenstruktur sollte durch Aufrufen des Microsoft Windows SDK HeapAlloc--Funktion zugewiesen werden, wobei das Handle verwendet wird, das im hOEMHeap--Mitglied der OEMCUIPPARAM-Struktur enthalten ist.

Wenn IPrintOemUI::CommonUIProp Methoden von mehreren Benutzeroberflächen-Plug-Ins exportiert werden, werden die Methoden in der Reihenfolge aufgerufen, in der die Plug-Ins für die Installation angegeben werden.

Weitere Informationen finden Sie unter Ändern einer Driver-Supplied Eigenschaftenblattseite.

Anforderungen

Anforderung	Wert
Zielplattform-	Desktop
Header-	prcomoem.h (einschließlich Prcomoem.h)

Freigeben über