Funzione GetUserObjectInformationA (winuser.h)

Articolo
03/13/2024

Recupera informazioni sulla stazione finestra o sull'oggetto desktop specificato.

Sintassi

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

Parametri

[in] hObj

Handle per la stazione finestra o l'oggetto desktop. Questo handle viene restituito dalla funzione CreateWindowStation, OpenWindowStation, CreateDesktop o OpenDesktop .

[in] nIndex

Informazioni da recuperare. Il parametro può essere uno dei valori seguenti.

Valore	Significato
UOI_FLAGS 1	Flag di handle. Il parametro pvInfo deve puntare a una struttura USEROBJECTFLAGS .
UOI_HEAPSIZE 5	Dimensioni dell'heap desktop, in KB, come valore di ULONG . Il parametro hObj deve essere un handle per un oggetto desktop. In caso contrario, la funzione ha esito negativo. Windows Server 2003 e Windows XP/2000: Questo valore non è supportato.
UOI_IO 6	TRUE se il parametro hObj è un handle per l'oggetto desktop che riceve l'input dall'utente. FALSE in caso contrario. Windows Server 2003 e Windows XP/2000: Questo valore non è supportato.
UOI_NAME 2	Nome dell'oggetto, come stringa.
UOI_TYPE 3	Nome del tipo dell'oggetto, come stringa.
UOI_USER_SID 4	Struttura SID che identifica l'utente attualmente associato all'oggetto specificato. Se all'oggetto non è associato alcun utente, il valore restituito nel buffer a cui punta lpnLengthNeeded è zero. Si noti che SID è una struttura a lunghezza variabile. In genere eseguirai una chiamata a GetUserObjectInformation per determinare la lunghezza del SID prima di recuperarne il valore.

[out, optional] pvInfo

Puntatore a un buffer per ricevere le informazioni sull'oggetto.

[in] nLength

Dimensioni del buffer a cui punta il parametro pvInfo , in byte.

[out, optional] lpnLengthNeeded

Puntatore a una variabile che riceve il numero di byte necessari per archiviare le informazioni richieste. Se il valore di questa variabile è maggiore del valore del parametro nLength quando la funzione restituisce , la funzione restituisce FALSE e nessuna delle informazioni viene copiata nel buffer pvInfo . Se il valore della variabile a cui punta lpnLengthNeed è minore o uguale al valore di nLength, viene copiato l'intero blocco di informazioni.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

Nota

L'intestazione winuser.h definisce GetUserObjectInformation come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winuser.h (include Windows.h)
Libreria	User32.lib
DLL	User32.dll
Set di API	ext-ms-win-ntuser-windowstation-ansi-l1-1-0 (introdotto in Windows 10, versione 10.0.10240)