GetUserObjectInformationA-Funktion (winuser.h)

Artikel
11/20/2024

Ruft Informationen zur angegebenen Fensterstation oder zum Desktopobjekt ab.

Syntax

BOOL GetUserObjectInformationA(
  [in]            HANDLE  hObj,
  [in]            int     nIndex,
  [out, optional] PVOID   pvInfo,
  [in]            DWORD   nLength,
  [out, optional] LPDWORD lpnLengthNeeded
);

Parameter

[in] hObj

Ein Handle für die Fensterstation oder das Desktopobjekt. Dieser Handle wird von der CreateWindowStation, OpenWindowStation, CreateDesktop-oder OpenDesktop--Funktion zurückgegeben.

[in] nIndex

Die abzurufenden Informationen. Der Parameter kann einen der folgenden Werte sein:

Wert	Bedeutung
UOI_FLAGS 1	Die Ziehpunktkennzeichnungen. Der pvInfo Parameter muss auf eine USEROBJECTFLAGS- Struktur verweisen.
UOI_HEAPSIZE 5	Die Größe des Desktop-Heaps in KB als ULONG-wert. Der hObj Parameter muss ein Handle für ein Desktopobjekt sein, andernfalls schlägt die Funktion fehl. Windows Server 2003 und Windows XP/2000: Dieser Wert wird nicht unterstützt.
UOI_IO 6	TRUE, wenn der hObj Parameter ein Handle für das Desktopobjekt ist, das Eingaben vom Benutzer empfängt. andernfalls FALSE. Windows Server 2003 und Windows XP/2000: Dieser Wert wird nicht unterstützt.
UOI_NAME 2	Der Name des Objekts als Zeichenfolge.
UOI_TYPE 3	Der Typname des Objekts als Zeichenfolge.
UOI_USER_SID 4	Die SID Struktur, die den Benutzer identifiziert, der derzeit dem angegebenen Objekt zugeordnet ist. Wenn dem Objekt kein Benutzer zugeordnet ist, ist der im Puffer zurückgegebene Wert, auf den lpnLengthNeeded verweist, null. Beachten Sie, dass SID- eine variable Längenstruktur ist. In der Regel rufen Sie GetUserObjectInformation auf, um die Länge der SID- zu bestimmen, bevor Sie den Wert abrufen.

[out, optional] pvInfo

Ein Zeiger auf einen Puffer, um die Objektinformationen zu empfangen.

[in] nLength

Die Größe des Puffers, auf den der pvInfo Parameter in Byte verweist.

[out, optional] lpnLengthNeeded

Ein Zeiger auf eine Variable, die die Anzahl der Bytes empfängt, die zum Speichern der angeforderten Informationen erforderlich sind. Wenn der Wert dieser Variablen größer als der Wert des nLength-Parameters ist, wenn die Funktion zurückgibt, gibt die Funktion FALSE zurück, und keine der Informationen wird in den pvInfo Puffer kopiert. Wenn der Wert der Variablen, auf die durch lpnLengthNeededed verweist, kleiner oder gleich dem Wert von nLengthist, wird der gesamte Informationsblock kopiert.

Rückgabewert

Wenn die Funktion erfolgreich ist, 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

Anmerkung

Der winuser.h-Header definiert GetUserObjectInformation 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-windowstation-ansi-l1-1-0 (eingeführt in Windows 10, Version 10.0.10240)