CommonPropertySheetUIW-Funktion (compstui.h)

Die CommonPropertySheetUI--Funktion von CPSUI zeigt Eigenschaftenblattseiten an und ermöglicht Benutzern Änderungen an angezeigten Werten.

Syntax

LONG CommonPropertySheetUIW(
  HWND           hWndOwner,
  PFNPROPSHEETUI pfnPropSheetUI,
  LPARAM         lParam,
  LPDWORD        pResult
);

Parameter

hWndOwner

Vom Aufrufer bereitgestellter Fensterziehpunkt, der das Fenster identifiziert, in dem neue Eigenschaftenblattseiten platziert werden sollen.

pfnPropSheetUI

Vom Aufrufer bereitgestellter Zeiger auf eine PFNPROPSHEETUI-typed callback function.

lParam

Vom Aufrufer bereitgestellter Wert, der als Eingabeargument für die pfnPropSheetUI--Funktion verwendet wird. Dieser Wert kann ein Zeiger sein.

pResult

Vom Aufrufer bereitgestellter Zeiger auf ein DWORD, das den endgültigen Rückgabestatus der pfnPropSheetUI Funktion empfängt. Wenn NULL-, wird der endgültige Rückgabestatus nicht zurückgegeben. Weitere Informationen finden Sie im Abschnitt Anmerkungen weiter unten.

Rückgabewert

Die CommonPropertySheetUI--Funktion gibt einen der folgenden Werte zurück:

Bemerkungen

Die CommonPropertySheetUI--Funktion ist der Einstiegspunkt von CPSUI für Anwendungen. Eine CPSUI-Anwendung (z. B. der Microsoft NT-basierte Druckspooler) kann die Funktion aufrufen, um einem vordefinierten übergeordneten Fenster eine oder mehrere Eigenschaftenblattseiten hinzuzufügen. CPSUI zeigt die Seiten an, ermöglicht es dem Benutzer, sie zu ändern, und benachrichtigt die Anwendung von Benutzeraktivitäten über Rückruffunktionen.

Der NT-basierte Betriebssystem-Druckspooler ruft die CommonPropertySheetUI--Funktion auf, wenn eine Win32-Anwendung die DocumentProperties-- oder PrinterProperties--Funktionen aufruft.

Die vom pfnPropSheetUI Parameter angegebene Rückruffunktion ist für die Beschreibung der hinzuzufügenden Eigenschaftenblattseiten verantwortlich. Weitere Informationen finden Sie in der Beschreibung des PFNPROPSHEETUI Funktionstyps.

Die Abfolge des Vorgangs lautet wie folgt:

1. Die CommonPropertySheetUI--Funktion ruft den pfnPropSheetUI- Rückruf auf, sodass der Rückruf die hinzuzufügenden Seiten beschreiben kann, indem die ComPropSheet--Funktion von CPSUI aufgerufen wird.

2. Wenn der pfnPropSheetUI Rückruf erfolgreich ist, zeigt die CommonPropertySheetUI--Funktion die neuen Eigenschaftenblattseiten an und ermöglicht es dem Benutzer, Seitenwerte zu ändern.

3. Wenn der Benutzer Seitenwerte ändert, wird ein Seitenereignisrückruf die Anwendung der Änderungen benachrichtigt.

4. Wenn der Benutzer die Schaltfläche OK oder Schaltfläche "Abbrechen" auswähelt, zerstört die funktion CommonPropertySheetUI die angezeigten Seiten und gibt diese zurück.

Weitere Informationen zur Abfolge des Vorgangs finden Sie unter Verwenden von CPSUI mit Druckertreibernim Abschnitt CPSUI-.

Die CommonPropertySheetUI--Funktion ruft die pfnPropSheetUI Rückruf mehrmals auf, wobei verschiedene Reason Memberwerte in der PROPSHEETUI_INFO Struktur des Rückrufs angegeben werden. Jedes Mal, wenn der Rückruf zurückgegeben wird, wird ein Ergebnisstatus im PROPSHEETUI_INFO Result Members der PROPSHEETUI_INFO Struktur platziert. Wenn die CommonPropertySheetUI--Funktion zurückgegeben wird, kopiert sie den endgültigen Inhalt Result in die Position, auf die pResult-verweist.

Anforderungen