PFNCOMPROPSHEET-Rückruffunktion (compstui.h)

Die ComPropSheet-Funktion wird von CPSUI bereitgestellt und kann von CPSUI-Anwendungen (einschließlich Druckerschnittstellen-DLLs) aufgerufen werden, um Eigenschaftenblattseiten zu erstellen.

Syntax

PFNCOMPROPSHEET Pfncompropsheet;

LONG_PTR Pfncompropsheet(
  [in] HANDLE hComPropSheet,
  [in] UINT Function,
  [in] LPARAM lParam1,
  [in] LPARAM lParam2
)
{...}

Parameter

[in] hComPropSheet

Das vom Aufrufer bereitgestellte Handle einer übergeordneten Eigenschaftenblattgruppe. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

[in] Function

Vom Aufrufer bereitgestellte, CPSFUNC_-präfixierte ComPropSheet-Funktionscodes, die den vorgang angeben, der von der ComPropSheet-Funktion ausgeführt werden soll. Weitere Informationen finden Sie in der Tabelle comPropSheet-Funktionscodes im Abschnitt Hinweise unten.

[in] lParam1

Vom Aufrufer bereitgestellter Wert, der vom ComPropSheet-Funktionscode für Function abhängt.

[in] lParam2

Vom Aufrufer bereitgestellter Wert, der vom ComPropSheet-Funktionscode für Function abhängt.

Rückgabewert

Der Rückgabewert hängt vom Für Function angegebenen ComPropSheet-Funktionscode ab.

Hinweise

Wenn CPSUI eine der PFNPROPSHEETUI-typisierten Funktionen einer Anwendung aufruft, übergibt es einen Zeiger auf die ComPropSheet-Funktion in einer PROPSHEETUI_INFO-Struktur . Eine PFNPROPSHEETUI-typisierte Funktion kann die ComPropSheet-Funktion aufrufen, um Eigenschaftenblattseiten für CPSUI zu beschreiben.

Eine Druckerschnittstellen-DLL kann ComPropSheet innerhalb der DrvDocumentPropertySheets-Funktion oder der DrvDevicePropertySheets-Funktion aufrufen.

Benutzeroberflächen-Plug-Ins für die Unidrv - und Pscript-Treiber von Microsoft können ComPropSheet aus ihren Methoden IPrintOemUI::D ocumentPropertySheets und IPrintOemUI::D evicePropertySheets aufrufen.

Das übergeordnete Gruppenhandle , das für den hComPropSheet-Parameter angegeben ist, kann einer der folgenden Sein:

• Das Handle, das im hComPropSheet-Member einer PROPSHEETUI_INFO-Struktur empfangen wird.

• Das Handle, das als Ergebnis eines früheren Aufrufs von ComPropSheet mit einem CPSFUNC_INSERT_PSUIPAGE Funktionscode und dem Angeben PSUIPAGEINSERT_GROUP_PARENT als Type-Member für eine INSERTPSUIPAGE_INFO-Struktur empfangen wurde.

ComPropSheet-Funktionscodes

Die folgenden Funktionscodes können an die ComPropSheet-Funktion von CPSUI übergeben werden:

CPSFUNC_ADD_HPROPSHEETPAGE

Der CPSFUNC_ADD_HPROPSHEETPAGE Funktionscode bewirkt, dass die ComPropSheet-Funktion eine Eigenschaftenblattseite hinzugibt, die durch Aufrufen der Funktion CreatePropertySheetPage erstellt wurde.

Parameter (CPSFUNC_ADD_HPROPSHEETPAGE)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_ADD_HPROPSHEETPAGE fest, wenn comPropSheet aufgerufen wird, um eine Eigenschaftenblattseite hinzuzufügen.

• lParam1: Handle to a property sheet page, abgerufen durch Aufrufen der CreatePropertySheetPage-Funktion

• lParam2: Nicht verwendet, muss null sein

Rückgabewert (CPSFUNC_ADD_HPROPSHEETPAGE)

Wenn der Vorgang erfolgreich ist, gibt ComPropSheet ein CPSUI-Handle an die hinzugefügte Seite zurück. Andernfalls wird NULL zurückgegeben.

CPSFUNC_ADD_PCOMPROPSHEETUI

Der CPSFUNC_ADD_PCOMPROPSHEETUI Funktionscode bewirkt, dass die ComPropSheet-Funktion einen Satz von mindestens einer Eigenschaftenblattseite hinzugibt, die durch eine COMPROPSHEETUI-Struktur beschrieben wird.

Parameter

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_ADD_PCOMPROPSHEETUI fest, wenn comPropSheet aufgerufen wird, um einen Satz von mindestens einer Eigenschaftenseite hinzuzufügen.

• lParam1: Zeiger auf eine COMPROPSHEETUI-Struktur

• lParam2: Zeiger auf einen 32-Bit-Speicherort, um die Anzahl der hinzugefügten Seiten zu empfangen, oder, wenn ein Fehler auftritt, einen fehlercode mit ERR_CPSUI Präfix

Rückgabewert

Wenn der Vorgang erfolgreich ist, gibt ComPropSheet ein Handle an den Satz der hinzugefügten Seiten zurück. Andernfalls gibt die Funktion NULL zurück.

CPSFUNC_ADD_PFNPROPSHEETUI

Der CPSFUNC_ADD_PFNPROPSHEETUI Funktionscode bewirkt, dass die ComPropSheet-Funktion die angegebene PFNPROPSHEETUI-typisierte Funktion aufruft, die einen Satz von mindestens einer Eigenschaftenblattseite hinzufügen muss.

Parameter (CPSFUNC_ADD_PFNPROPSHEETUI)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_ADD_PFNPROPSHEETUI fest, wenn ComPropSheet aufgerufen wird. ComPropSheet ruft dann die angegebene PFNPROPSHEETUI-typed-Funktion auf, um einen Satz von mindestens einer Eigenschaftenblattseite hinzuzufügen.

• lParam1: Zeiger auf eine PFNPROPSHEETUI-typisierte Funktion

• lParam2: Ein 32-Bit-Wert, der für den lParam-Parameter an die PFNPROPSHEETUI-typisierte Funktion übergeben wird

Rückgabewert (CPSFUNC_ADD_PFNPROPSHEETUI)

Wenn der Vorgang erfolgreich ist, gibt ComPropSheet ein Handle an den Satz der hinzugefügten Seiten zurück. Andernfalls gibt die Funktion NULL zurück.

CPSFUNC_ADD_PROPSHEETPAGE

Der CPSFUNC_ADD_PROPSHEETPAGE Funktionscode bewirkt, dass die ComPropSheet-Funktion den Typ der Eigenschaftenblattseite hinzugibt, die durch eine PROPSHEETPAGE-Struktur beschrieben wird.

Parameter (CPSFUNC_ADD_PROPSHEETPAGE)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_ADD_PROPSHEETPAGE fest, wenn ComPropSheet aufgerufen wird, um den Typ der Eigenschaftenblattseite hinzuzufügen, die durch eine PROPSHEETPAGE-Struktur beschrieben wird. Die ComPropSheet-Funktion ruft die CreatePropertySheetPage-Funktion auf und übergibt die Adresse der PROPSHEETPAGE-Struktur , um die Seite zu erstellen.

• lParam1: Zeiger auf eine PROPSHEETPAGE-Struktur

• lParam2: Nicht verwendet, muss null sein

Rückgabewert (CPSFUNC_ADD_PROPSHEETPAGE)

Wenn der Vorgang erfolgreich ist, gibt ComPropSheet ein CPSUI-Handle an die hinzugefügte Seite zurück. Andernfalls wird NULL zurückgegeben.

CPSFUNC_DELETE_HCOMPROPSHEET

Der CPSFUNC_DELETE_HCOMPROPSHEET Funktionscode bewirkt, dass die ComPropSheet-Funktion eine Reihe von Eigenschaftenblattseiten löscht, die durch ein CPSUI-Handle angegeben werden.

Parameter (CPSFUNC_DELETE_HCOMPROPSHEET)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_DELETE_HCOMPROPSHEET fest, wenn comPropSheet aufgerufen wird, um eine Reihe von Eigenschaftenblattseiten zu löschen.

• lParam1: CPSUI-Handle, das auf die Gruppe der zu löschenden Seiten verweist. Dieses Handle muss zuvor durch einen Aufruf von ComPropSheet mit einem der folgenden Funktionscodes abgerufen worden sein:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PCOMPROPSHEETUI

  • CPSFUNC_ADD_PFNPROPSHEETUI

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE

• lParam2: Nicht verwendet, muss null sein

Rückgabewert (CPSFUNC_DELETE_HCOMPROPSHEET)

Die ComPropSheet-Funktion gibt die Anzahl der Eigenschaftenblattseiten zurück, die gelöscht wurden.

CPSFUNC_DO_APPLY_CPSUI

Der CPSFUNC_DO_APPLY_CPSUI Funktionscode bewirkt, dass die ComPropSheet-Funktion die Übermittlung einer PSN_APPLY Benachrichtigungsnachricht simuliert.

CPSUI reagiert auf den CPSFUNC_DO_APPLY_CPSUI-Funktionscode , indem der CPSUICB_REASON_APPLYNOW Grund an die _CPSUICALLBACK-typisierte Rückruffunktion einer Anwendung bereitgestellt wird.

Parameter (CPSFUNC_DO_APPLY_CPSUI)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_DO_APPLY_CPSUI fest, wenn comPropSheet aufgerufen wird, um die Übermittlung einer PSN_APPLY Benachrichtigungsnachricht zu simulieren.

• lParam1: CPSUI-Handle, das auf einen Satz von mindestens einer Eigenschaftenblattseite verweist. In der Regel wurde dieses Handle zuvor als lParam1-Parameter für ComPropSheet mithilfe des CPSFUNC_IGNORE_CPSUI_PSN_APPLY-Funktionscodes angegeben.

• lParam2: Dieser Parameter ist eine beliebige Kombination der folgenden Bitflags:

  • APPLYCPSUI_NO_NEWDEF: Legen Sie dieses Flag fest, wenn sie nicht möchten, dass die aktuellen Standardwerte (die für den Vorgang Rückgängig verwendet werden) geändert werden sollen. Deaktivieren Sie dieses Flag, wenn die aktuellen Werte für alle Optionen zu den Standardwerten werden sollen, die für den Vorgang Rückgängig verwendet werden.

  • APPLYCPSUI_OK_CANCEL_BUTTON: Legen Sie dieses Flag fest, wenn der Benutzer die Schaltfläche OK oder Abbrechen ausgewählt hat (oder wenn Sie diese Aktivität simulieren möchten). Deaktivieren Sie dieses Flag, wenn der Benutzer die Schaltfläche Schließen oder Jetzt anwenden ausgewählt hat (oder wenn Sie diese Aktivität simulieren möchten). Wenn Ihr Code für den Empfang PSN_APPLY Nachrichten eingerichtet ist, sollte der Code das lParam-Element der PSHNOTIFY-Struktur überprüfen. Wenn das Element 0 ist, sollte dieses Bit gelöscht werden.

Rückgabewert (CPSFUNC_DO_APPLY_CPSUI)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion einen Nonzero-Wert zurück. Andernfalls wird null zurückgegeben, und die angegebenen Seiten werden aktiv.

Wenn Sie den CPSFUNC_IGNORE_CPSUI_PSN_APPLY Funktionscode verwenden, um die Verarbeitung der PSN_APPLY Benachrichtigungsnachricht durch CPSUI zu deaktivieren, müssen Sie den CPSFUNC_DO_APPLY_CPSUI Funktionscode verwenden, um die Übermittlung der PSN_APPLY Nachricht zu simulieren. Andernfalls können Benutzeränderungen an einer Eigenschaftenblattseite nicht abgerufen werden.

CPSFUNC_GET_HPSUIPAGES

Der CPSFUNC_GET_HPSUIPAGES Funktionscode bewirkt, dass die ComPropSheet-Funktion ein Array von CPSUI-Handles zurückgibt, die auf Eigenschaftenblattseiten verweisen. Diese Handles identifizieren die untergeordneten Seiten, die dem angegebenen übergeordneten Gruppenhandle zugeordnet sind.

Führen Sie die folgenden Schritte aus, um diesen Funktionscode zu verwenden:

• Rufen Sie ComPropSheet auf, und geben Sie den CPSFUNC_GET_PAGECOUNT Funktionscode an, um die Anzahl der untergeordneten Seiten abzurufen, die dem angegebenen übergeordneten Gruppenelement zugeordnet sind.

• Weisen Sie genügend lokalen Arbeitsspeicher zu, um eine HANDLE-Struktur für jede Seite zu enthalten.

• Rufen Sie ComPropSheet erneut auf, und geben Sie den CPSFUNC_GET_HPSUIPAGES Funktionscode und die Adresse des lokal zugeordneten Arbeitsspeichers an, um ein Array von HANDLE-Strukturen zu erhalten.

Parameter (CPSFUNC_GET_HPSUIPAGES)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_GET_HPSUIPAGES fest, wenn ComPropSheet aufgerufen wird, um ein Array von CPSUI-Handles abzurufen.

• lParam1: Zeiger auf ein Array von HANDLE-Strukturen

• lParam2: Größe des HANDLE-Arrays, auf das von lParam1 verwiesen wird

Rückgabewert (CPSFUNC_GET_HPSUIPAGES)

Die ComPropSheet-Funktion gibt die Anzahl der Handles zurück, die CPSUI im HANDLE-Array platziert.

CPSFUNC_GET_PAGECOUNT

Der CPSFUNC_GET_PAGECOUNT Funktionscode bewirkt, dass die ComPropSheet-Funktion die Anzahl der Eigenschaftenblattseiten zurückgibt, die untergeordnete Seiten des angegebenen übergeordneten Gruppenhandles sind.

Parameter (CPSFUNC_GET_PAGECOUNT)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_GET_PAGECOUNT fest, wenn ComPropSheet aufgerufen wird, um die Anzahl der untergeordneten Seiten zurückzugeben.

• lParam1: Nicht verwendet, muss null sein

• lParam2: Nicht verwendet, muss null sein

Rückgabewert (CPSFUNC_GET_PAGECOUNT)

Die ComPropSheet-Funktion gibt die Anzahl der gezählten Seiten zurück.

CPSFUNC_GET_PFNPROPSHEETUI_ICON

Der CPSFUNC_GET_PFNPROPSHEETUI_ICON Funktionscode bewirkt, dass die ComPropSheet-Funktion ein Handle an das Symbol zurückgibt, das einem Satz von Eigenschaftenblattseiten zugeordnet ist. Der Satz von Seiten muss zuvor von einer PFNPROPSHEETUI-typisierten Funktion erstellt worden sein.

Die ComPropSheet-Funktion ruft die pfNPROPSHEETUI-typisierte Funktion auf, die dem angegebenen Seitenhandle zugeordnet ist, und übergibt den Grundwert PROPSHEETUI_REASON_GET_ICON. Die PFNPROPSHEETUI-typisierte Funktion ruft dann LoadImage auf und stellt die vonlParam2 angegebene Symbolgröße zum Laden einer Symbolressource bereit.

Parameter (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_GET_PFNPROPSHEETUI_ICON fest, wenn ComPropSheet aufgerufen wird, um ein Handle für das Symbol abzurufen, das einem Satz von Eigenschaftenblattseiten zugeordnet ist.

• lParam1: CPSUI-Handle, das auf eine Reihe von Eigenschaftenblattseiten verweist. Dieses Handle muss zuvor durch einen Aufruf von ComPropSheet mit dem CPSFUNC_ADD_PFNPROPSHEETUI Funktionscode abgerufen worden sein.

• lParam2: Gibt zwei WORD-Größenwerte an, die die Größe des Symbols in Pixel darstellen. Der LOWORD-Wert ist die Breite, und der HIWORD-Wert ist die Höhe. Wenn diese Werte null sind, werden die Systemmetriken SM_CXICON und SM_CYICON verwendet. Weitere Informationen finden Sie unter GetSystemMetrics.

Rückgabewert (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion ein Symbolhandle zurück. Andernfalls wird NULL zurückgegeben.

CPSFUNC_IGNORE_CPSUI_PSN_APPLY

Der CPSFUNC_IGNORE_CPSUI_PSN_APPLY Funktionscode bewirkt, dass die ComPropSheet-Funktion die Behandlung der PSN_APPLY Benachrichtigung durch CPSUI deaktiviert oder erneut aktiviert.

Das System sendet die PSN_APPLY-Benachrichtigung an CPSUI, wenn ein Benutzer die Schaltfläche OK oder Abbrechen eines Eigenschaftenblatts auswählt. CPSUI antwortet auf diese Nachricht, indem der CPSUICB_REASON_APPLYNOW Grund an die _CPSUICALLBACK-typisierte Rückruffunktion einer Anwendung übergeben wird.

Wenn Sie die Verarbeitung der PSN_APPLY Benachrichtigung durch CPSUI deaktivieren, müssen Sie den CPSFUNC_DO_APPLY_CPSUI Funktionscode verwenden, um die Übermittlung der PSN_APPLY Nachricht zu simulieren. Andernfalls können Benutzeränderungen an einer Eigenschaftenblattseite nicht abgerufen werden.

Wenn der CPSFUNC_IGNORE_CPSUI_PSN_APPLY Funktionscode nicht verwendet wird, ist die Behandlung der PSN_APPLY Benachrichtigung durch CPSUI standardmäßig aktiviert.

Parameter (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_IGNORE_CPSUI_PSN_APPLY fest, wenn ComPropSheet aufgerufen wird, um die Behandlung der PSN_APPLY Benachrichtigung durch CPSUI zu deaktivieren oder erneut zu aktivieren.

• lParam1: CPSUI-Handle, das auf eine Gruppe von eigenschaftenblattseitigen Seiten verweist. Dieses Handle muss zuvor durch einen Aufruf von ComPropSheet mit einem Funktionscode von CPSFUNC_ADD_PCOMPROPSHEETUI oder mit einem Funktionscode von CPSFUNC_INSERT_PSUIPAGE und einem Einfügetyp von PSUIPAGEINSERT_PROPSHEETPAGE abgerufen worden sein.

• lParam2: Jeder Wert ungleich null deaktiviert die CpSUI-Übermittlung des CPSUICB_REASON_APPLYNOW Grunds. Ein Nullwert kann die Übermittlung des CPSUICB_REASON_APPLYNOW Grunds erneut zulassen.

Rückgabewert (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion einen Wert ungleich null zurück. Andernfalls wird 0 (null) zurückgegeben.

CPSFUNC_INSERT_PSUIPAGE

Der CPSFUNC_INSERT_PSUIPAGE Funktionscode bewirkt, dass die ComPropSheet-Funktion einen Satz von Eigenschaftenblattseiten an einer bestimmten Position einfügt.

Parameter (CPSFUNC_INSERT_PSUIPAGE)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_INSERT_PSUIPAGE fest, wenn ComPropSheet aufgerufen wird, um eine Reihe von Eigenschaftenblattseiten an einer bestimmten Position einzufügen.

• lParam1: Gibt ein Handle für eine Gruppe von eigenschaftenblattseitigen Seiten an. Die neuen Seiten werden vor oder nach diesen Seiten eingefügt, abhängig vom Moduselement der INSERTPSUIPAGE_INFO Struktur, auf die lParam2 verweist. Dieses Handle muss zuvor durch einen Aufruf von ComPropSheet mit einem der folgenden Funktionscodes abgerufen worden sein:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PCOMPROPSHEETUI

  • CPSFUNC_ADD_PFNPROPSHEETUI

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE

• lParam2: Zeiger auf eine INSERTPSUIPAGE_INFO-Struktur , der beschreibt, wo und wie die neuen Seiten eingefügt werden sollen

Rückgabewert (CPSFUNC_INSERT_PSUIPAGE)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion ein Handle für die Gruppe der eingefügten Seiten zurück. Andernfalls gibt die Funktion NULL zurück.

CPSFUNC_LOAD_CPSUI_ICON

Der CPSFUNC_LOAD_CPSUI_ICON Funktionscode bewirkt, dass die ComPropSheet-Funktion eine von CPSUI bereitgestellte Symbolressource lädt.

CPSUI ruft LoadImage auf, um die angegebene Symbolressource zu laden.

Parameter (CPSFUNC_LOAD_CPSUI_ICON)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_LOAD_CPSUI_ICON fest, wenn ComPropSheet aufgerufen wird, um eine von CPSUI bereitgestellte Symbolressource zu laden.

• lParam1: Ressourcenbezeichner des von CPSUI bereitgestellten Symbols, das geladen werden soll. Dies muss ein bezeichner mit IDI_CPSUI Präfix sein, wie in Compstui.h definiert.

• lParam2: Gibt zwei WORD-Größenwerte an, die die Größe des Symbols in Pixel darstellen. Der LOWORD-Wert ist die Breite, und der HIWORD-Wert ist die Höhe. Wenn diese Werte null sind, werden die Systemmetriken SM_CXICON und SM_CYICON verwendet. Weitere Informationen finden Sie unter GetSystemMetrics.

Rückgabewert (CPSFUNC_LOAD_CPSUI_ICON)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion ein Symbolhandle zurück. Andernfalls wird NULL zurückgegeben.

CPSFUNC_LOAD_CPSUI_STRING

Der CPSFUNC_LOAD_CPSUI_STRING Funktionscode bewirkt, dass die ComPropSheet-Funktion eine von CPSUI bereitgestellte Zeichenfolgenressource lädt.

Die ComPropSheet-Funktion ruft die LoadString](/windows/win32/api/winuser/nf-winuser-loadstringw)-Funktion auf, um die angegebene Zeichenfolge zu laden.

Parameter (CPSFUNC_LOAD_CPSUI_STRING)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_LOAD_CPSUI_STRING fest, wenn ComPropSheet aufgerufen wird, um eine von CPSUI bereitgestellte Zeichenfolgenressource zu laden.

• lParam1: Ein LPSTR-typisierter Zeiger auf einen vom Aufrufer zugewiesenen Puffer, in den die von CPSUI bereitgestellte Zeichenfolge, die durch HIWORD(lParam2) angegeben wird, platziert wird.

• lParam2: Enthält die folgenden beiden vom Aufrufer bereitgestellten Werte:

  • LOWORD(lParam2). Größe des Puffers in Bytes, auf den lParam1 verweist.

  • HIWORD(lParam2). Ressourcenbezeichner der von CPSUI bereitgestellten Zeichenfolge, die geladen werden soll. Dies muss ein bezeichner mit IDS_CPSUI Präfix sein, wie in Compstui.h definiert.

Rückgabewert (CPSFUNC_LOAD_CPSUI_STRING)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion die Länge der Zeichenfolge zurück. Wenn ein ungültiger Ressourcenbezeichner angegeben wird, gibt die Funktion null zurück. Wenn lParam1 NULL oder LOWORD(lParam2) null ist, gibt die Funktion -1 zurück.

CPSFUNC_QUERY_DATABLOCK

Der CPSFUNC_QUERY_DATABLOCK Funktionscode bewirkt, dass die ComPropSheet-Funktion einen vom Aufrufer bereitgestellten Datenblock abruft, der zuvor mit dem CPSFUNC_SET_DATABLOCK Funktionscode gespeichert wurde.

In der Regel wird dieser Funktionscode von einer _CPSUICALLBACK-typisierten Rückruffunktion verwendet (wenn die CPSUICBPARAM-Struktur der Funktion den Reason-Wert CPSUICB_REASON_SETACTIVE enthält), um Werte abzurufen, die einer anderen Seite zugeordnet sind, bevor die aktuelle Seite inaktiv wird.

Parameter (CPSFUNC_QUERY_DATABLOCK)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_QUERY_DATABLOCK fest, wenn ComPropSheet aufgerufen wird, um einen vom Aufrufer bereitgestellten Datenblock abzurufen.

• lParam1: Zeiger auf eine CPSUIDATABLOCK-Struktur , die die Größe und position eines Puffers zum Empfangen des angeforderten Datenblocks identifiziert

• lParam2: Bezeichnerwert im DWORD-Format, der verwendet wird, um die angeforderte CPSUIDATABLOCK-Struktur zu identifizieren. Dieser Wert muss in einem vorherigen Aufruf von ComPropSheet mithilfe des Funktionscodes der CPSFUNC_SET_DATABLOCK angegeben worden sein.

Rückgabewert (CPSFUNC_QUERY_DATABLOCK)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion einen Wert zurück, der die Größe des abgerufenen Datenblocks darstellt. Wenn lParam1 NULL ist oder der Wert eines Elements der angegebenen CPSUIDATABLOCK-Struktur null ist, gibt ComPropSheet die größe zurück, die zum Speichern des Datenblocks erforderlich ist. Wenn ein Fehler auftritt, gibt die Funktion einen Wert zurück, der kleiner oder gleich 0 ist.

CPSFUNC_SET_DATABLOCK

Der CPSFUNC_SET_DATABLOCK Funktionscode bewirkt, dass die ComPropSheet-Funktion einen vom Aufrufer bereitgestellten Datenblock speichert. Sie können diesen Funktionscode verwenden, um die Informationen zu einer Eigenschaftenblattseite anderen Seiten zur Verfügung zu stellen.

In der Regel wird dieser Funktionscode von einer _CPSUICALLBACK typisierten Rückruffunktion verwendet (wenn die CPSUICBPARAM-Struktur der Funktion den Reason-Wert CPSUICB_REASON_KILLACTIVE enthält), um Werte zu speichern, die einer Seite zugeordnet sind, bevor sie inaktiv wird.

Parameter (CPSFUNC_SET_DATABLOCK)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_DATABLOCK fest, wenn ComPropSheet aufgerufen wird, um einen vom Aufrufer bereitgestellten Datenblock zu speichern.

• lParam1: Zeiger auf eine CPSUIDATABLOCK-Struktur , die den zu speichernden Datenblock beschreibt

• lParam2: Aufruferdefiniertes DWORD-Bezeichnerwert. Es wird verwendet, um die angegebene CPSUIDATABLOCK-Struktur in nachfolgenden Aufrufen von ComPropSheet mithilfe des CPSFUNC_QUERY_DATABLOCK Funktionscode zu identifizieren.

Rückgabewert (CPSFUNC_SET_DATABLOCK)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion einen Wert zurück, der die Anzahl der gespeicherten Bytes darstellt. Andernfalls wird ein Wert zurückgegeben, der kleiner oder gleich 0 ist.

CPSFUNC_SET_DMPUB_HIDEBITS

Der CPSFUNC_SET_DMPUB_HIDEBITS Funktionscode bewirkt, dass die ComPropSheet-Funktion einen angegebenen Satz von Dokumenteigenschaftenoptionen "ausblendet", sodass sie nicht angezeigt werden.

Sie können den CPSFUNC_SET_DMPUB_HIDEBITS Funktionscode verwenden, wenn Sie OPTITEM-Strukturen für eine oder mehrere Dokumenteigenschaftenblattoptionen definieren möchten, die Optionen jedoch nicht vom Benutzer geändert werden können. Die Eigenschaftenblattseite muss mithilfe der COMPROPSHEETUI-Struktur definiert werden, und der pDlgPage-Member der Struktur muss CPSUI_PDLGPAGE_DOCPROP oder CPSUI_PDLGPAGE_ADVDOCPROP sein.

Wenn Sie den CPSFUNC_SET_DMPUB_HIDEBITS Funktionscode verwenden, muss dieser in ComPropSheet angegeben werden, bevor der CPSFUNC_ADD_PCOMPROPSHEETUI oder CPSFUNC_INSERT_PSUIPAGE Funktionscode verwendet wird, um die Seite zu erstellen.

Parameter (CPSFUNC_SET_DMPUB_HIDEBITS)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_DMPUB_HIDEBITS fest, wenn ComPropSheet aufgerufen wird, um einen angegebenen Satz von Dokumenteigenschaftenoptionen auszublenden.

• lParam1: Zeiger auf ein Bitarray, das die optionen angibt, die ausgeblendet werden sollen. Dieses Array muss mithilfe des Makros MAKE_DMPUB_HIDEBIT (DMPub) erstellt werden, wobei DMPub die OR-Kombination einer oder mehrerer DMPUB_ Konstanten mit Präfix ist. Die konstanten DMPUB_ sind in der Beschreibung der OPTITEM-Struktur aufgeführt. Das Makro und die Konstanten sind in Compstui.h definiert.

• lParam2: Nicht verwendet, muss null sein

Rückgabewert (CPSFUNC_SET_DMPUB_HIDEBITS)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion den für lParam1 angegebenen Wert zurück. Andernfalls wird 0 (null) zurückgegeben.

CPSFUNC_SET_FUSION_CONTEXT

Die CPSFUNC_SET_FUSION_CONTEXT legt einen Fusion-Aktivierungskontext für die angegebene Seite fest.

Wenn eine Seite im Begriff ist, erstellt oder eingefügt zu werden, und sie keinen Aktivierungskontext in der PROPSHEETPAGE-Struktur angibt, wird sie im Seitenaktivierungskontext des übergeordneten Elements erstellt.

Wenn der Aktivierungskontext des übergeordneten Elements nicht festgelegt ist, sucht Compstui.dll das übergeordnete Element des übergeordneten Elements des übergeordneten Elements und wird so lange fortgesetzt, bis das übergeordnete Element der obersten Ebene erreicht ist oder ein übergeordnetes Element gefunden wird, dessen Aktivierungskontext ordnungsgemäß festgelegt ist.

Wenn keines der übergeordneten Elemente einen Aktivierungskontext festgelegt hat, gibt Compstui.dll keinen Aktivierungskontext in der PROPSHEETPAGE-Struktur an. Dies bedeutet, dass die Seite im Aktivierungskontext des Aufrufers der PropertySheet-Funktion erstellt wird.

Parameter (CPSFUNC_SET_FUSION_CONTEXT)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_FUSION_CONTEXT fest, wenn ComPropSheet aufgerufen wird, um einen Fusion-Aktivierungskontext für die angegebene Seite festzulegen.

• lParam1: Gibt das Handle für den Fusion-Kontext an. Compstui.dll dupliziert den Handle und fügt es an seine internen Strukturen an, sodass der Aufrufer nicht verpflichtet ist, das Handle beizubehalten. Compstui.dll gibt das übergebene Kontexthandle frei, wenn das Compstui.dll-Handle gelöscht wird.

• lParam2: Nicht verwendet, muss null sein

Rückgabewert (CPSFUNC_SET_FUSION_CONTEXT)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion einen Wert zurück, der größer als 0 ist. Andernfalls gibt ComPropSheet einen Wert zurück, der kleiner oder gleich 0 ist. Verwenden Sie die GetLastError-Funktion , um Informationen zum Fehler zu erhalten.

CPSFUNC_SET_HSTARTPAGE

Der CPSFUNC_SET_HSTARTPAGE Funktionscode bewirkt, dass die ComPropSheet-Funktion eine angegebene Eigenschaftenblattseite als oberste Seite des zugeordneten Eigenschaftenblatts markiert. Wenn das Eigenschaftenblatt derzeit angezeigt wird, wird die angegebene Seite zur aktiven Seite.

Parameter (CPSFUNC_SET_HSTARTPAGE)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_HSTARTPAGE fest, wenn ComPropSheet aufgerufen wird, um eine angegebene Eigenschaftenblattseite als oberste Seite des zugeordneten Eigenschaftenblatts zu markieren.

• lParam1: Vom Aufrufer bereitgestelltes CPSUI-Seitenhandle, das zuvor durch einen Aufruf von ComPropSheet mit einem der folgenden Funktionscodes abgerufen wurde:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PCOMPROPSHEETUI

  • CPSFUNC_ADD_PFNPROPSHEETUI

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE

  Wenn das Handle eine einzelne Seite darstellt, die zu der durch hComPropSheet angegebenen Gruppe gehört, wird diese Seite von CPSUI zur obersten Seite.

  Wenn das Handle ein übergeordnetes Gruppenhandle darstellt (siehe CPSFUNC_INSERT_PSUIPAGE), stellt lParam2 einen nullbasierten Index in den Seiten der Gruppe dar, und die durch den Index dargestellte Seite wird zur obersten Seite.

• lParam2: Wenn lParam1 ein übergeordnetes Gruppenhandle darstellt, ist dieser vom Aufrufer bereitgestellte Wert ein nullbasierter Index in den Seiten der Gruppe. Wenn lParam1 eine einzelne Seite darstellt, die zu der durch hComPropSheet angegebenen Gruppe gehört, wird dieser Parameter nicht verwendet. Wenn das von lParam1 angegebene Handle mit dem CPSFUNC_ADD_PCOMPROPSHEETUI Funktionscode abgerufen wurde und der pDlgPage-Member der zugeordneten COMPROPSHEETUI-Struktur auf CPSUI_PDLGPAGE_DOCPROP festgelegt wurde, kann für lParam2 einer der folgenden Werte angegeben werden:

  • SSP_STDPAGE1: Legen Sie die Layoutseite als oberste Seite fest.

  • SSP_STDPAGE2: Machen Sie die Seite "Papier/Qualität" zur obersten Seite.

  • SSP_TVPAGE: Machen Sie die Seite Erweitert zur obersten Seite.

Rückgabewert (CPSFUNC_SET_HSTARTPAGE)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion den für lParam1 angegebenen Wert zurück. Andernfalls wird 0 (null) zurückgegeben.

CPSFUNC_SET_PSUIPAGE_ICON

Der CPSFUNC_SET_PSUIPAGE_ICON Funktionscode bewirkt, dass die ComPropSheet-Funktion das der Registerkarte einer Eigenschaftenblattseite zugewiesene Symbol hinzufügen, ersetzen oder entfernen kann.

Wenn lParam2 ein Symbolhandle enthält und die von lParam1 angegebene Seite derzeit angezeigt wird, fügt CPSUI das Symbol zur Registerkarte der angegebenen Seite hinzu. Wenn der Seite bereits ein Symbol zugewiesen ist, wird das alte Symbol durch das neue ersetzt. Wenn lParam2 null ist, wird das aktuelle Symbol (sofern vorhanden) entfernt.

Für alle Symbole, die mit dem CPSFUNC_SET_PSUIPAGE_ICON-Funktionscode angegeben sind, legt CPSUI die Bildgröße auf 16 x 16 Pixel fest.

Symbolhandles sollten durch Aufrufen von LoadImage abgerufen werden.

Parameter (CPSFUNC_SET_PSUIPAGE_ICON)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_PSUIPAGE_ICON fest, wenn comPropSheet aufgerufen wird, um das der Registerkarte einer Eigenschaftenblattseite zugewiesene Symbol hinzuzufügen, zu ersetzen oder zu entfernen.

• lParam1: Vom Aufrufer bereitgestelltes CPSUI-Seitenhandle, das zuvor durch einen Aufruf von ComPropSheet mit einem der folgenden Funktionscodes abgerufen wurde:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE (wobei der Type-Member der INSERTPSUIPAGE_INFO-Struktur auf PSUIPAGEINSERT_HPROPSHEETPAGE oder PSUIPAGEINSERT_PROPSHEETPAGE festgelegt ist)

• lParam2: Vom Aufrufer bereitgestelltes Symbolhandle. Sie können diesen Parameter auf 0 festlegen, um das aktuelle Symbol zu entfernen.

Rückgabewert (CPSFUNC_SET_PSUIPAGE_ICON)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion 1 zurück. Wenn ein Fehler auftritt oder die angegebene Seite derzeit nicht angezeigt wird, gibt die Funktion null zurück.

CPSFUNC_SET_PSUIPAGE_TITLE

Der CPSFUNC_SET_PSUIPAGE_TITLE Funktionscode bewirkt, dass die ComPropSheet-Funktion den Registerkartentitel für eine Eigenschaftenblattseite fest legt.

Parameter (CPSFUNC_SET_PSUIPAGE_TITLE)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_PSUIPAGE_TITLE fest, wenn comPropSheet aufgerufen wird, um den Registerkartentitel für eine Eigenschaftenblattseite festzulegen.

• lParam1: Vom Aufrufer bereitgestelltes CPSUI-Seitenhandle, das zuvor durch einen Aufruf von ComPropSheet mit einem der folgenden Funktionscodes abgerufen wurde:

  • CPSFUNC_ADD_HPROPSHEETPAGE

  • CPSFUNC_ADD_PROPSHEETPAGE

  • CPSFUNC_INSERT_PSUIPAGE (wobei das Element Typ der INSERTPSUIPAGE_INFO-Struktur auf PSUIPAGEINSERT_HPROPSHEETPAGE oder PSUIPAGEINSERT_PROPSHEETPAGE festgelegt ist).

• lParam2: Vom Aufrufer bereitgestellter Zeiger auf eine NULL-beendete Zeichenfolge, die den neuen Titel angibt

Rückgabewert (CPSFUNC_SET_PSUIPAGE_TITLE)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion 1 zurück. Wenn ein Fehler auftritt oder die angegebene Seite derzeit nicht angezeigt wird, gibt die Funktion null zurück.

CPSFUNC_SET_RESULT

Der CPSFUNC_SET_RESULT Funktionscode bewirkt, dass die ComPropSheet-Funktion einen angegebenen Ergebniswert an alle pfNPROPSHEETUI-typisierten Funktionen übergibt, die einer angegebenen Seite und ihren übergeordneten Elementen zugeordnet sind.

Weitere Informationen zum Festlegen von Ergebniswerten finden Sie in der Beschreibung der SETRESULT_INFO-Struktur .

Die folgende Vorsicht gilt für unidrv- oder Pscript5-basiertes IHV UI-Plug-In mit benutzerdefinierten Ui-Eigenschaftenblättern, für die benutzerspezifische Einstellungen, die in den Eigenschaftenblättern vorgenommen werden, persistent sein sollten. Wenn das Plug-In die ComPropSheet-Funktion aufruft, wobei der Funktionsparameter auf CPSFUNC_SET_RESULT festgelegt ist, muss das Plug-In den lParam2-Parameter auf CPSUI_OK festlegen.

Parameter (CPSFUNC_SET_RESULT)

• hComPropSheet: Übergeordnetes Gruppenhandle

• Funktion: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_RESULT fest, wenn ComPropSheet aufgerufen wird, um einen angegebenen Ergebniswert an alle funktionen vom Typ PFNPROPSHEETUI zu übergeben, die einer angegebenen Seite und ihren übergeordneten Elementen zugeordnet sind.

• lParam1: Vom Aufrufer bereitgestelltes CPSUI-Handle an die Seite, für die ein Ergebniswert übergeben wird. Wenn lParam1 NULL ist, verwendet CPSUI den von hComPropSheet angegebenen Wert.

• lParam2: Vom Aufrufer bereitgestellter 32-Bit-DWORD-Ergebniswert.

Rückgabewert (CPSFUNC_SET_RESULT)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-Funktion die Anzahl der aufgerufenen PFNPROPSHEETUI-typisierten Funktionen zurück. Wenn das für lParam1 angegebene Handle ungültig ist, gibt die Funktion -1 zurück.

Anforderungen

Anforderung	Wert
Zielplattform	Desktop
Kopfzeile	compstui.h (einschließlich Compstui.h)