PropertySheetA-Funktion (prsht.h)

  • Artikel
  • 2 Minuten Lesedauer

Erstellt ein Eigenschaftenblatt und fügt die seiten hinzu, die in der angegebenen Eigenschaftenblattkopfstruktur definiert sind.

Syntax

INT_PTR PropertySheetA(
  LPCPROPSHEETHEADERA unnamedParam1
);

Parameter

unnamedParam1

Typ: LPCPROPSHEETHEADER

Zeiger auf eine PROPSHEETHEADER-Struktur , die den Frame und die Seiten eines Eigenschaftenblatts definiert.

Rückgabewert

Typ: INT_PTR

Bei modalen Eigenschaftenblättern lautet der Rückgabewert wie folgt:

>=1 Änderungen wurden vom Benutzer gespeichert.
0 Vom Benutzer wurden keine Änderungen gespeichert.
-1 Ein Fehler ist aufgetreten.
 

Bei moduslosen Eigenschaftenblättern ist der Rückgabewert der Fensterziehpunkt des Eigenschaftenblatts.

Die folgenden Rückgabewerte haben eine besondere Bedeutung.

Rückgabecode Beschreibung
ID_PSREBOOTSYSTEM
 Eine Seite hat die PSM_REBOOTSYSTEM Nachricht an das Eigenschaftenblatt gesendet. Der Computer muss neu gestartet werden, damit die Änderungen des Benutzers wirksam werden.
ID_PSRESTARTWINDOWS
 Eine Seite hat die PSM_RESTARTWINDOWS Nachricht an das Eigenschaftenblatt gesendet. Windows muss neu gestartet werden, damit die Änderungen des Benutzers wirksam werden.

Hinweise

Rufen Sie GetLastError auf, um erweiterte Fehlerinformationen abzurufen.

Wenn Sie versuchen, einem Eigenschaftenblatt mehr als 99 Seiten hinzuzufügen, schlägt diese Funktion fehl, aber ohne Hinweis auf die Ursache des Fehlers: PropertySheet gibt einen Wert von -1 zurück, aber GetLastError gibt 0 zurück.

Hinweis Die folgenden Hinweise beziehen sich nur auf Assistenten, die nicht den Aero-Assistentenstil (PSH_AEROWIZARD) oder Nicht-Assistenten-Eigenschaftenblätter verwenden.
 
Standardmäßig erstellt die PropertySheet-Funktion ein modales Dialogfeld. Wenn das dwFlags-Element der PROPSHEETHEADER-Struktur das PSH_MODELESS Flag angibt, erstellt PropertySheet ein modusloses Dialogfeld und gibt unmittelbar nach der Erstellung zurück. In diesem Fall ist der Rückgabewert "PropertySheet " der Fensterziehpunkt für das Dialogfeld ohne Modus.

Bei einem moduslosen Eigenschaftenblatt sollte ihre Nachrichtenschleife PSM_ISDIALOGMESSAGE verwenden, um Nachrichten an das Eigenschaftenblattdialogfeld zu übergeben. Die Nachrichtenschleife sollte PSM_GETCURRENTPAGEHWND verwenden, um zu bestimmen, wann das Dialogfeld zerstört werden soll. Wenn der Benutzer auf die Schaltfläche "OK " oder "Abbrechen " klickt, gibt PSM_GETCURRENTPAGEHWNDNULL zurück. Anschließend können Sie die Funktion "DestroyWindow " verwenden, um das Dialogfeld zu zerstören.

Version 5.80. Der Rückgabewert "PropertySheet " enthält unterschiedliche Informationen für modale und moduslose Eigenschaftenblätter. In einigen Fällen benötigen moduslose Eigenschaftenblätter möglicherweise die Informationen, die sie von PropertySheet erhalten hätten, wenn sie modal waren. Insbesondere müssen sie möglicherweise wissen, ob ID_PSREBOOTSYSTEM oder ID_PSRESTARTWINDOWS zurückgegeben worden wären. Ein modusloses Eigenschaftenblatt kann den Wert abrufen, den ein modales Eigenschaftenblatt von PropertySheet erhalten hätte, indem er wartet, bis PSM_GETCURRENTPAGEHWNDNULL zurückgibt und dann eine PSM_GETRESULT Nachricht sendet.

Hinweis

Der prsht.h-Header definiert PropertySheet als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der codierungsneutralen Aliase mit Code, der nicht codierungsneutral ist, kann zu Übereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows Vista [Nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [Nur Desktop-Apps]
Zielplattform Windows
Kopfzeile prsht.h
Bibliothek Comctl32.lib
DLL Comctl32.dll
APIs ext-ms-win-shell-comctl32-window-l1-1-0 (eingeführt in Windows 10, Version 10.0.14393)