Freigeben über

PFNCOMPROPSHEET-Rückruffunktion (compstui.h)

  • Artikel

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

Vom Aufrufer bereitgestelltes Handle für ein Eigenschaftenblatt übergeordneten Gruppen-. 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 Anmerkungen weiter unten.

[in] lParam1

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

[in] lParam2

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

Rückgabewert

Der Rückgabewert hängt vom ComPropSheet-Funktionscode ab, für Functionbereitgestellt wird.

Bemerkungen

Wenn CPSUI eine der PFNPROPSHEETUI--typierten Funktionen einer Anwendung aufruft, übergibt sie einen Zeiger an die ComPropSheet--Funktion in einer PROPSHEETUI_INFO Struktur. Eine PFNPROPSHEETUI--typd-Funktion kann die ComPropSheet--Funktion aufrufen, um Eigenschaftenblattseiten in CPSUI zu beschreiben.

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

Plug-Ins für die Benutzeroberfläche für die Unidrv- von Microsoft und Pscript Treiber können ComPropSheet- innerhalb von ihre IPrintOemUI::D ocumentPropertySheets und IPrintOemUI::D evicePropertySheets Methoden.

Das übergeordnete Handle für das hComPropSheet--Parameter kann eine der folgenden sein:

  • Der im hComPropSheet Member einer PROPSHEETUI_INFO Struktur empfangene Handle.

  • Das Handle, das als Ergebnis des zuvor aufgerufenen ComPropSheet- mit einem CPSFUNC_INSERT_PSUIPAGE Funktionscode empfangen wurde und PSUIPAGEINSERT_GROUP_PARENT als Type-Element für eine INSERTPSUIPAGE_INFO Struktur angibt.

ComPropSheet-Funktionscodes

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

CPSFUNC_ADD_HPROPSHEETPAGE

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

Parameter (CPSFUNC_ADD_HPROPSHEETPAGE)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

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

  • lParam1: Handle zu einer Eigenschaftenblattseite, die durch Aufrufen der CreatePropertySheetPage-funktion abgerufen wird

  • 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 einer oder mehreren Eigenschaftenblattseiten hinzugibt, die durch eine COMPROPSHEETUI- Struktur beschrieben werden.

Parameter

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_ADD_PCOMPROPSHEETUI fest, wenn ComPropSheet- aufgerufen wird, um eine Gruppe von einer oder mehreren Eigenschaftenblattseiten hinzuzufügen.

  • lParam1: Zeiger auf eine COMPROPSHEETUI--Struktur

  • lParam2-: Zeiger auf eine 32-Bit-Position, um die Anzahl der hinzugefügten Seiten zu erhalten, oder, wenn ein Fehler auftritt, ein ERR_CPSUI-Präfix-Fehlercode

Rückgabewert

Wenn der Vorgang erfolgreich ist, gibt ComPropSheet- ein Handle an den Satz hinzugefügter 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-typd-Funktion aufruft, die einen Satz von einer oder mehreren Eigenschaftenblattseiten hinzufügen muss.

Parameter (CPSFUNC_ADD_PFNPROPSHEETUI)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_ADD_PFNPROPSHEETUI fest, wenn er ComPropSheet-aufruft. ComPropSheet- ruft dann die angegebene PFNPROPSHEETUI-Typd-Funktion auf, um eine Gruppe von einer oder mehreren Eigenschaftenblattseiten hinzuzufügen.

  • lParam1: Zeiger auf eine PFNPROPSHEETUI-Typfunktion

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

Rückgabewert (CPSFUNC_ADD_PFNPROPSHEETUI)

Wenn der Vorgang erfolgreich ist, gibt ComPropSheet- ein Handle an den Satz hinzugefügter 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

  • Function: 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 einen Satz von Eigenschaftenblattseiten löscht, die von einem CPSUI-Handle angegeben werden.

Parameter (CPSFUNC_DELETE_HCOMPROPSHEET)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_DELETE_HCOMPROPSHEET fest, wenn er ComPropSheet- aufruft, um eine Reihe von Eigenschaftenblattseiten zu löschen.

  • lParam1: CPSUI-Handle, das auf den zu löschenden Seitensatz 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 Benachrichtigung simuliert.

CPSUI antwortet auf den CPSFUNC_DO_APPLY_CPSUI Funktionscode, indem der CPSUICB_REASON_APPLYNOW Grund für die _CPSUICALLBACK-Typ-Rückruffunktion einer Anwendung bereitgestellt wird.

Parameter (CPSFUNC_DO_APPLY_CPSUI)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_DO_APPLY_CPSUI fest, wenn ComPropSheet- aufgerufen wird, um die Übermittlung einer PSN_APPLY-Benachrichtigung zu simulieren.

  • lParam1: CPSUI-Handle, das auf eine Gruppe von einer oder mehreren Eigenschaftenblattseiten verweist. In der Regel wurde dieses Handle zuvor als lParam1-Parameter angegeben, um comPropSheet-mithilfe des CPSFUNC_IGNORE_CPSUI_PSN_APPLY-Funktionscodes zu.

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

    • APPLYCPSUI_NO_NEWDEF – Legen Sie dieses Flag fest, wenn die aktuellen Standardwerte (die für den Rückgängig-Vorgang verwendet werden) nicht geändert werden sollen. Deaktivieren Sie dieses Kennzeichen, wenn die aktuellen Werte für alle Optionen als Standardwerte für den Rückgängig-Vorgang verwendet werden sollen.

    • APPLYCPSUI_OK_CANCEL_BUTTON – Legen Sie dieses Kennzeichen 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 Kennzeichen, wenn der Benutzer die Schaltfläche "Jetzt 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 null ist, sollte dieses Bit gelöscht werden.

Rückgabewert (CPSFUNC_DO_APPLY_CPSUI)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet--Funktion einen Wert ungleich Null 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 Benachrichtigung durch CPSUI zu deaktivieren, müssen Sie den CPSFUNC_DO_APPLY_CPSUI Funktionscode verwenden, um die Zustellung 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 Speicher 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 zugewiesenen Speichers an, um ein Array von HANDLE-Strukturen abzurufen.

Parameter (CPSFUNC_GET_HPSUIPAGES)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: 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 lParam1 verweist

Rückgabewert (CPSFUNC_GET_HPSUIPAGES)

Die ComPropSheet--Funktion gibt die Anzahl der Handles zurück, die CPSUI in das 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

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_GET_PAGECOUNT fest, wenn er ComPropSheet- aufruft, 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-typierten Funktion erstellt worden sein.

Die ComPropSheet--Funktion ruft die PFNPROPSHEETUI-Typd-Funktion auf, die dem angegebenen Seitenhandle zugeordnet ist, und übergibt einen Grundwert von PROPSHEETUI_REASON_GET_ICON. Anschließend ruft die PFNPROPSHEETUI-typd-Funktion LoadImage- auf und stellt die durchlParam2 angegebene Symbolgröße zum Laden einer Symbolressource bereit.

Parameter (CPSFUNC_GET_PFNPROPSHEETUI_ICON)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_GET_PFNPROPSHEETUI_ICON fest, wenn ComPropSheet- aufgerufen wird, um ein Handle für das Symbol abzurufen, das einer Reihe 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 Pixeln 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 Verarbeitung der PSN_APPLY-Benachrichtigung deaktivieren oder wiederverwenden kann.

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 für die _CPSUICALLBACK-Typ-Rückruffunktion einer Anwendung bereitgestellt wird.

Wenn Sie die Verarbeitung der PSN_APPLY Benachrichtigung durch CPSUI deaktivieren, müssen Sie den CPSFUNC_DO_APPLY_CPSUI Funktionscode verwenden, um die Zustellung 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 Verarbeitung der PSN_APPLY-Benachrichtigung durch CPSUI standardmäßig aktiviert.

Parameter (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_IGNORE_CPSUI_PSN_APPLY fest, wenn er ComPropSheet- aufruft, um die Verarbeitung der PSN_APPLY Benachrichtigung durch CPSUI zu deaktivieren oder erneut zu verarbeiten.

  • lParam1: CPSUI-Handle, das auf einen Satz von einem oder mehreren Eigenschaftenblattseiten verweist. Dieses Handle muss zuvor durch einen Aufruf von ComPropSheet- mit einem Funktionscode von CPSFUNC_ADD_PCOMPROPSHEETUIoder mit einem Funktionscode von CPSFUNC_INSERT_PSUIPAGE und einem Einfügetyp von PSUIPAGEINSERT_PROPSHEETPAGEabgerufen worden sein.

  • lParam2: Jeder Wert ungleich Null deaktiviert die Übermittlung des CPSUICB_REASON_APPLYNOW Grundes von CPSUI. Ein Nullwert lässt die Übermittlung des CPSUICB_REASON_APPLYNOW Grunds erneut zu.

Rückgabewert (CPSFUNC_IGNORE_CPSUI_PSN_APPLY)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet--Funktion einen Wert ungleich Null zurück. andernfalls wird Null zurückgegeben.

CPSFUNC_INSERT_PSUIPAGE

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

Parameter (CPSFUNC_INSERT_PSUIPAGE)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: 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 einem oder mehreren Eigenschaftenblattseiten an. Die neuen Seiten werden vor oder nach diesen Seiten eingefügt, abhängig vom Element "Mode" der INSERTPSUIPAGE_INFO Struktur, auf die durch lParam2verwiesen wird. 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, die 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 an den Satz eingefügter 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 cpSUI-bereitgestellte Symbolressource lädt.

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

Parameter (CPSFUNC_LOAD_CPSUI_ICON)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: 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 cpSUI-bereitgestellten Symbols, das geladen werden soll. Dies muss ein IDI_CPSUI-Präfix-Bezeichner sein, wie in Compstui.h definiert.

  • lParam2: Gibt zwei WORD-Größenwerte an, die die Größe des Symbols in Pixeln 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 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

  • Function: 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 durch HIWORD(lParam2) angegebene CPSUI-Zeichenfolge 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 cpSUI-bereitgestellten Zeichenfolge, die geladen werden soll. Dies muss ein IDS_CPSUI-Präfix-Bezeichner 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 ist, gibt die Funktion null zurück. Wenn lParam1 NULL oder LOWORD(lParam2) 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 mithilfe des CPSFUNC_SET_DATABLOCK-Funktionscodes gespeichert wurde.

In der Regel wird dieser Funktionscode von einer _CPSUICALLBACK-Typ-Rückruffunktion verwendet (wenn die CPSUICBPARAM--Struktur der Funktion einen Grundwert von 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

  • Function: 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 identifiziert, um den angeforderten Datenblock zu empfangen

  • lParam2: DWORD-Größenbezeichnerwert, der verwendet wird, um die angeforderte CPSUIDATABLOCK- Struktur zu identifizieren. Dieser Wert muss in einem vorherigen Aufruf von ComPropSheet- mithilfe des CPSFUNC_SET_DATABLOCK-Funktionscodes 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 des angegebenen CPSUIDATABLOCK- Struktur null ist, gibt ComPropSheet- die zum Speichern des Datenblocks erforderliche Größe zurück. Wenn ein Fehler auftritt, gibt die Funktion einen Wert kleiner oder gleich Null zurück.

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 für andere Seiten verfügbar zu machen.

In der Regel wird dieser Funktionscode von einer _CPSUICALLBACK-Typ-Rückruffunktion verwendet (wenn die CPSUICBPARAM--Struktur der Funktion einen Grundwert von 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

  • Function: 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: Bezeichnerwert der benutzerdefinierten DWORD-Größe. Es wird verwendet, um die bereitgestellte CPSUIDATABLOCK- Struktur in nachfolgenden Aufrufen von ComPropSheet- mithilfe des CPSFUNC_QUERY_DATABLOCK Funktionscodes 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 kleiner oder gleich Null zurückgegeben.

CPSFUNC_SET_DMPUB_HIDEBITS

Der CPSFUNC_SET_DMPUB_HIDEBITS-Funktionscode bewirkt, dass die ComPropSheet- Funktion einen angegebenen Satz von Dokumenteigenschaftenoptionen "ausblenden", 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_ADVDOCPROPsein.

Wenn Sie den CPSFUNC_SET_DMPUB_HIDEBITS-Funktionscode verwenden, muss er für ComPropSheet- angegeben werden, bevor der CPSFUNC_ADD_PCOMPROPSHEETUI- oder CPSFUNC_INSERT_PSUIPAGE Funktionscode zum Erstellen der Seite verwendet wird.

Parameter (CPSFUNC_SET_DMPUB_HIDEBITS)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_DMPUB_HIDEBITS fest, wenn er ComPropSheet- aufruft, um eine bestimmte Gruppe von Dokumenteigenschaftenoptionen auszublenden.

  • lParam1: Zeiger auf ein Bitarray, das angibt, welche Optionen ausgeblendet werden sollen. Dieses Array muss mithilfe des MAKE_DMPUB_HIDEBIT-Makros (DMPub) erstellt werden, wobei DMPub die OR-Kombination einer oder mehrerer DMPUB_-präfixierten Konstanten ist. Die DMPUB_-präfixierten Konstanten sind in der Beschreibung der OPTITEM--Struktur aufgeführt. Das Makro und die Konstanten werden 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 lParam1angegebenen Wert zurück; andernfalls wird 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 gerade erstellt oder eingefügt werden soll und kein Aktivierungskontext in der PROPSHEETPAGE- Struktur angegeben wird, 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 nach, und wird fortgesetzt, bis das übergeordnete Übergeordnete der obersten Ebene erreicht ist oder bis ein übergeordnetes Element gefunden wird, dessen Aktivierungskontext ordnungsgemäß festgelegt ist.

Wenn keine der übergeordneten Komponenten 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

  • Function: 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 ihn an seine internen Strukturen an, sodass der Aufrufer nicht verpflichtet ist, den 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 größer als 0 zurück. Andernfalls gibt ComPropSheet einen Wert zurück, der kleiner oder gleich Null 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 zurzeit angezeigt wird, wird die angegebene Seite zur aktiven Seite.

Parameter (CPSFUNC_SET_HSTARTPAGE)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: 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 kennzeichnen.

  • lParam1: Vom Aufrufer bereitgestellter 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 der Handle eine einzelne Seite darstellt, die zu der gruppe gehört, die durch hComPropSheet-angegeben wird, macht CPSUI diese Seite 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 auf den Seiten der Gruppe. Wenn lParam1- eine einzelne Seite darstellt, die zur gruppe gehört, die von hComPropSheetangegeben wird, wird dieser Parameter nicht verwendet. Wenn das durch lParam1 angegebene Handle mithilfe des CPSFUNC_ADD_PCOMPROPSHEETUI Funktionscodes abgerufen wurde und wenn das pDlgPage-Element des zugeordneten COMPROPSHEETUI- Struktur auf CPSUI_PDLGPAGE_DOCPROPfestgelegt wurde, kann für lParam2einer der folgenden Werte angegeben werden:

    • SSP_STDPAGE1 – Gestalten Sie die Layoutseite als oberste Seite.

    • SSP_STDPAGE2 – Erstellen Sie die Seite "Papier/Qualität" auf der obersten Seite.

    • SSP_TVPAGE – Legen Sie die Seite "Erweitert" auf die oberste Seite fest.

Rückgabewert (CPSFUNC_SET_HSTARTPAGE)

Wenn der Vorgang erfolgreich ist, gibt die ComPropSheet-funktion den für lParam1angegebenen Wert zurück; andernfalls wird Null zurückgegeben.

CPSFUNC_SET_PSUIPAGE_ICON

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

Wenn lParam2 einen Symbolpunkt 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

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_PSUIPAGE_ICON fest, wenn ComPropSheet- aufgerufen wird, um das Symbol hinzuzufügen, zu ersetzen oder zu entfernen, das der Registerkarte einer Eigenschaftenblattseite zugewiesen ist.

  • lParam1: Vom Aufrufer bereitgestellter 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 Typelement der INSERTPSUIPAGE_INFO Struktur auf PSUIPAGEINSERT_HPROPSHEETPAGE oder PSUIPAGEINSERT_PROPSHEETPAGEfestgelegt ist)

  • lParam2: Vom Anrufer bereitgestellter Symbolziehpunkt. Sie können diesen Parameter auf Null 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 zurzeit 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 festlegen.

Parameter (CPSFUNC_SET_PSUIPAGE_TITLE)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: 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 bereitgestellter 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 Typelement der INSERTPSUIPAGE_INFO Struktur auf PSUIPAGEINSERT_HPROPSHEETPAGE oder PSUIPAGEINSERT_PROPSHEETPAGEfestgelegt ist).

  • lParam2: Vom Aufrufer bereitgestellter Zeiger auf eine MIT 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 zurzeit 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-typierten Funktionen übergibt, die einer angegebenen Seite und den übergeordneten Funktionen 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 und für welche Benutzereinstellungen in den Eigenschaftenblättern dauerhaft sein sollten. Wenn das Plug-In die ComPropSheet--Funktion aufruft, wobei der Parameter "Function" auf CPSFUNC_SET_RESULTfestgelegt ist, muss das Plug-In den Parameter "lParam2" auf CPSUI_OKfestlegen.

Parameter (CPSFUNC_SET_RESULT)

  • hComPropSheet-: Übergeordnetes Gruppenhandle

  • Function: Der Aufrufer legt diesen Funktionscodeparameter auf CPSFUNC_SET_RESULT fest, wenn ComPropSheet- aufgerufen wird, um einen angegebenen Ergebniswert an alle PFNPROPSHEETUI-typierten Funktionen zu übergeben, die einer angegebenen Seite und den übergeordneten Funktionen zugeordnet sind.

  • lParam1: Vom Aufrufer bereitgestelltes CPSUI-Handle an die Seite, für die ein Ergebniswert übergeben wird. Wenn lParam1 NULL ist, verwendet die CPSUI den durch hComPropSheetangegebenen 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-Typfunktionen zurück. Wenn der für lParam1 angegebene Handle ungültig ist, gibt die Funktion -1 zurück.

Anforderungen

Anforderung Wert
Zielplattform- Desktop
Header- compstui.h (include Compstui.h)