SetPropA-Funktion (winuser.h)

Artikel
11/20/2024

Fügt einen neuen Eintrag hinzu oder ändert einen vorhandenen Eintrag in der Eigenschaftenliste des angegebenen Fensters. Die Funktion fügt der Liste einen neuen Eintrag hinzu, wenn die angegebene Zeichenfolge nicht bereits in der Liste vorhanden ist. Der neue Eintrag enthält die Zeichenfolge und das Handle. Andernfalls ersetzt die Funktion den aktuellen Handle der Zeichenfolge durch den angegebenen Handle.

Syntax

BOOL SetPropA(
  [in]           HWND   hWnd,
  [in]           LPCSTR lpString,
  [in, optional] HANDLE hData
);

Parameter

[in] hWnd

Typ: HWND-

Ein Handle für das Fenster, dessen Eigenschaftsliste den neuen Eintrag erhält.

[in] lpString

Typ: LPCTSTR-

Eine mit Null beendete Zeichenfolge oder ein Atom, das eine Zeichenfolge identifiziert. Wenn dieser Parameter ein Atom ist, muss es sich um ein globales Atom sein, das durch einen vorherigen Aufruf der GlobalAddAtom- Funktion erstellt wurde. Das Atom muss im Wort mit niedriger Reihenfolge von lpStringplatziert werden; Das Wort "Hochreihenfolge" muss null sein.

[in, optional] hData

Typ: HANDLE

Ein Handle für die Daten, die in die Eigenschaftsliste kopiert werden sollen. Der Datenhandle kann jeden für die Anwendung nützlichen Wert identifizieren.

Rückgabewert

Typ: BOOL-

Wenn der Eigenschaftenliste das Datenhandle und die Zeichenfolge hinzugefügt werden, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Bevor ein Fenster zerstört wird (d. h., bevor es von der Verarbeitung der WM_NCDESTROY Nachricht zurückgegeben wird), muss eine Anwendung alle Einträge entfernen, die sie der Eigenschaftenliste hinzugefügt hat. Die Anwendung muss die RemoveProp--Funktion verwenden, um die Einträge zu entfernen.

SetProp- unterliegen den Einschränkungen der Benutzeroberflächenberechtigungsisolation (User Interface Privilege Isolation, UIPI). Ein Prozess kann diese Funktion nur in einem Fenster aufrufen, das zu einem Prozess mit geringerer oder gleicher Integritätsebene gehört. Wenn UIPI Eigenschaftsänderungen blockiert, gibt GetLastError- 5 zurück.

Beispiele

Ein Beispiel finden Sie unter Hinzufügen einer Window-Eigenschaft.

Anmerkung

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

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winuser.h (enthalten Windows.h)
Library	User32.lib
DLL-	User32.dll
API-Satz	ext-ms-win-ntuser-window-l1-1-4 (eingeführt in Windows 10, Version 10.0.14393)