PFNPROPSHEETUI-Rückruffunktion (compstui.h)

Der PFNPROPSHEETUI-Funktionstyp wird von CPSUI-Anwendungen (einschließlich Druckerschnittstellen-DLLs) zum Definieren von Seitenerstellungsrückrufen verwendet, die Eigenschaftenblattseiten für die Erstellung angeben.

Syntax

PFNPROPSHEETUI Pfnpropsheetui;

LONG Pfnpropsheetui(
  PPROPSHEETUI_INFO pPSUIInfo,
  LPARAM lParam
)
{...}

Parameter

pPSUIInfo

Von CPSUI bereitgestellter Zeiger auf eine PROPSHEETUI_INFO-Struktur .

lParam

Von CPSUI bereitgestellter ganzzahliger Wert, der vom Inhalt des Reason-Elements der PROPSHEETUI_INFO-Struktur abhängt. Gültige Werte sind:

PROPSHEETUI_REASON_BEFORE_INIT

Dieser Wert ist neu in Windows 8 und wird nur für den ursprünglichen PFNPROPSHEETUI-Parameter bereitgestellt, der an CommonPropertySheetUI übergeben wird.

PROPSHEETUI_REASON_DESTROY

Der lParam-Wert ist ungleich null, wenn der Benutzer die Schaltfläche OK oder Abbrechen des Eigenschaftenblatts ausgewählt hat. Andernfalls ist der Wert null.

PROPSHEETUI_REASON_GET_ICON

Der lParam-Wert ist ein Zeiger auf eine PROPSHEETUI_GETICON_INFO-Struktur .

PROPSHEETUI_REASON_GET_INFO_HEADER

Der lParam-Wert ist ein Zeiger auf eine PROPSHEETUI_INFO_HEADER-Struktur .

PROPSHEETUI_REASON_INIT

Wenn die Rückruffunktion vom pfnPropSheetUI-Parameter für CommonPropertySheetUI angegeben wird, ist lParam der lParam-Wert , der an CommonPropertySheetUI übergeben wird.

Wenn die Rückruffunktion mithilfe des CPSFUNC_ADD_PFNPROPSHEETUI Funktionscode mit der ComPropSheet-Funktion von CPSUI angegeben wird, ist lParam der lParam2-Wert , der an ComPropSheet übergeben wird.

CPSUI kopiert den lParam-Wert in den lParamInit-Member der PROPSHEETUI_INFO-Struktur der Funktion.

Der lParam-Wert darf sich nicht im Stapel der Anwendung befinden.

PROPSHEETUI_REASON_SET_RESULT

Der lParam-Wert ist ein Zeiger auf eine SETRESULT_INFO-Struktur .

Rückgabewert

Wenn der Vorgang erfolgreich ist, sollte die Funktion den Wert 1 (oder höher) zurückgeben. Andernfalls sollte ein Wert zurückgegeben werden, der kleiner als eins ist.

Rückgabecode	Beschreibung
Mindestens eine.	Die PFNPROPSHEETUI-Funktion, die dem übergeordneten Element der aktuellen Seite zugeordnet ist, wird aufgerufen.
Kleiner als 1.	Die PFNPROPSHEETUI-Funktion, die dem übergeordneten Element der aktuellen Seite zugeordnet ist, wird nicht aufgerufen.

Hinweise

Rückruffunktionen, die mit dem Funktionstyp PFNPROPSHEETUI angegeben werden, werden von Anwendungen bereitgestellt, die CPSUI zum Verwalten benutzerdefinierter Eigenschaftenblattseiten verwenden. Eine solche Rückruffunktion muss angegeben werden, wenn eine Anwendung die CommonPropertySheetUI-Funktion aufruft . Wenn der NT-basierte Druckspooler des Betriebssystems beispielsweise die CommonPropertySheetUI-Funktion von CPSUI aufruft, um die Funktionen DocumentProperties oder PrinterProperties zu unterstützen, gibt der Spooler eine interne Rückruffunktion vom Typ PFNPROPSHEETUI an.

Anwendungen können zusätzliche PFNPROPSHEETUI-typisierte Rückruffunktionen angeben, indem sie die ComPropSheet-Funktion von CPSUI mit dem Funktionscode CPSFUNC_ADD_PFNPROPSHEETUI aufrufen. Der NT-basierte Betriebssystemdruckspooler tut dies beispielsweise, um CPSUI über das Vorhandensein der Funktionen DrvDocumentPropertySheets und DrvDevicePropertySheets einer Druckerschnittstellen-DLL zu benachrichtigen. Ebenso verwenden die Unidrv - und Pscript-Treiber von Microsoft diese Technik, um CPSUI über das Vorhandensein der Methoden IPrintOemUI::D ocumentPropertySheets und IPrintOemUI::D evicePropertySheets in Benutzeroberflächen-Plug-Ins zu informieren.

Jede PFNPROPSHEETUI-typisierte Rückruffunktion wird von CPSUI mehrmals aufgerufen. Der Reason-Member der PROPSHEETUI_INFO-Struktur legt den Vorgang fest, den die Funktion wie folgt ausführen soll:

Anforderungen

Anforderung	Wert
Zielplattform	Desktop
Kopfzeile	compstui.h (include Compstui.h)