SetPropA-Funktion (winuser.h)

Artikel
03/13/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 das aktuelle Handle der Zeichenfolge durch das angegebene 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 Eigenschaftenliste den neuen Eintrag empfängt.

[in] lpString

Typ: LPCTSTR

Eine NULL-Zeichenfolge oder ein Atom, das eine Zeichenfolge identifiziert. Wenn es sich bei diesem Parameter um ein Atom handelt, muss es sich um ein globales Atom handelt, das durch einen vorherigen Aufruf der GlobalAddAtom-Funktion erstellt wurde. Das Atom muss im Wort mit niedriger Ordnung von lpString platziert werden; Das Wort mit hoher Ordnung muss 0 (null) sein.

[in, optional] hData

Typ: HANDLE

Ein Handle für die Daten, die in die Eigenschaftenliste kopiert werden sollen. Das Datenhandle kann jeden wert identifizieren, der für die Anwendung nützlich ist.

Rückgabewert

Typ: BOOL

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

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Bevor ein Fenster zerstört wird (d. h. bevor es von der Verarbeitung der WM_NCDESTROY Nachricht zurückgibt), 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 unterliegt 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 Eigenschaftenänderungen blockiert, gibt GetLastError 5 zurück.

Beispiele

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

Hinweis

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
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winuser.h (windows.h einschließen)
Bibliothek	User32.lib
DLL	User32.dll
APIs	ext-ms-win-ntuser-window-l1-1-4 (eingeführt in Windows 10, Version 10.0.14393)