CommonPropertySheetUIA-Funktion (compstui.h)
Die CommonPropertySheetUI-Funktion von CPSUI zeigt Eigenschaftenblattseiten an und ermöglicht Benutzeränderungen, um angezeigte Werte anzuzeigen.
Syntax
LONG CommonPropertySheetUIA(
HWND hWndOwner,
PFNPROPSHEETUI pfnPropSheetUI,
LPARAM lParam,
LPDWORD pResult
);
Parameter
hWndOwner
Vom Aufrufer bereitgestelltes Fensterhandle, das das Fenster angibt, in dem neue Eigenschaftenblattseiten platziert werden sollen.
pfnPropSheetUI
Vom Aufrufer bereitgestellter Zeiger auf eine PFNPROPSHEETUI-typisierte Rückruffunktion.
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 die endgültige Rückgabe status der Funktion pfnPropSheetUI empfängt. Bei NULL wird die endgültige rückgabe status nicht zurückgegeben. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".
Rückgabewert
Die CommonPropertySheetUI-Funktion gibt einen der folgenden Werte zurück:
| Rückgabecode | Beschreibung |
|---|---|
| CPSUI_CANCEL | Die PfnPropSheetUI-Funktion hat einen negativen Wert zurückgegeben. |
| CPSUI_OK | Der Vorgang wurde erfolgreich ausgeführt. |
| CPSUI_REBOOTSYSTEM | Der Vorgang war erfolgreich, und eine Dialogfeldprozedur hat die PSM_REBOOTSYSTEM Nachricht gesendet. |
| CPSUI_RESTARTWINDOWS | Der Vorgang war erfolgreich, und eine Dialogfeldprozedur hat die PSM_RESTARTWINDOWS Nachricht gesendet. |
| Fehlercode mit ERR_CPSUI Präfix | Ein Fehler ist aufgetreten. Die ERR_CPSUI-Präfix-Fehlercodes sind in compstui.h definiert. |
Hinweise
Die CommonPropertySheetUI-Funktion ist der Einstiegspunkt von CPSUI für Anwendungen. Eine CPSUI-Anwendung (z. B. der Microsoft NT-basierte Betriebssystemdruckspooler) 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 der Benutzeraktivität über Rückruffunktionen.
Der NT-basierte Betriebssystemdruckspooler ruft die CommonPropertySheetUI-Funktion auf, wenn eine Win32-Anwendung die DocumentProperties - oder PrinterProperties-Funktionen des Spoolers 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 Reihenfolge des Vorgangs lautet wie folgt:
Die CommonPropertySheetUI-Funktion ruft den pfnPropSheetUI-Rückruf auf, damit der Rückruf die hinzuzufügenden Seiten beschreiben kann, indem die ComPropSheet-Funktion von CPSUI aufgerufen wird.
Wenn der pfnPropSheetUI-Rückruf erfolgreich ist, zeigt die CommonPropertySheetUI-Funktion die neuen Eigenschaftenblattseiten an und ermöglicht es dem Benutzer, Seitenwerte zu ändern.
Wenn der Benutzer Seitenwerte ändert, benachrichtigt ein Seitenereignisrückruf die Anwendung der Änderungen.
Wenn der Benutzer die Schaltfläche OK oder Abbrechen auswähelt, zerstört die CommonPropertySheetUI-Funktion die angezeigten Seiten und gibt zurück.
Weitere Informationen zur Reihenfolge der Vorgänge finden Sie unter Verwenden von CPSUI mit Druckertreibern im Abschnitt CPSUI.
Die CommonPropertySheetUI-Funktion ruft den pfnPropSheetUI-Rückruf tatsächlich mehrmals auf und gibt unterschiedliche Reason-Memberwerte in der PROPSHEETUI_INFO Struktur des Rückrufs an. Jedes Mal, wenn der Rückruf zurückgegeben wird, platziert er ein Ergebnis status im Ergebniselement der PROPSHEETUI_INFO-Struktur. Wenn die CommonPropertySheetUI-Funktion zurückgibt, kopiert sie den endgültigen Inhalt von Result an die Position, auf die pResult verweist.
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Desktop |
| Kopfzeile | compstui.h (einschließlich Compstui.h) |