GetUserObjectInformationA-Funktion (winuser.h)

Artikel
03/04/2024

Ruft Informationen zur angegebenen Fensterstation oder zum angegebenen 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. Dieses Handle wird von der Funktion CreateWindowStation, OpenWindowStation, CreateDesktop oder OpenDesktop zurückgegeben.

[in] nIndex

Die abzurufenden Informationen. Der Parameter kann einer der folgenden Werte sein.

Wert	Bedeutung
UOI_FLAGS 1	Die Handleflags. Der parameter pvInfo muss auf eine USEROBJECTFLAGS-Struktur verweisen.
UOI_HEAPSIZE 5	Die Größe des Desktopheaps 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 wert, der im Puffer zurückgegeben wird, auf den lpnLengthNeeded verweist, null. Beachten Sie, dass die SID eine Struktur mit variabler Länge ist. In der Regel führen Sie einen Aufruf von GetUserObjectInformation durch, um die Länge der SID vor dem Abrufen des Werts zu bestimmen.

[out, optional] pvInfo

Ein Zeiger auf einen Puffer zum Empfangen der Objektinformationen.

[in] nLength

Die Größe des Puffers, auf den der pvInfo-Parameter in Bytes 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 von lpnLengthNeeded verwiesen wird , kleiner oder gleich dem Wert von nLength ist, wird der gesamte Informationsblock kopiert.

Rückgabewert

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

Hinweis

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
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-windowstation-ansi-l1-1-0 (eingeführt in Windows 10, Version 10.0.10240)