GetUserObjectInformationA, fonction (winuser.h)

Article
03/13/2024

Récupère des informations sur la station de fenêtre ou l’objet de bureau spécifié.

Syntaxe

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

Paramètres

[in] hObj

Handle de la station de fenêtre ou de l’objet de bureau. Ce handle est retourné par la fonction CreateWindowStation, OpenWindowStation, CreateDesktop ou OpenDesktop .

[in] nIndex

Informations à récupérer. Le paramètre peut être l’une des valeurs suivantes.

Valeur	Signification
UOI_FLAGS 1	Indicateurs de handle. Le paramètre pvInfo doit pointer vers une structure USEROBJECTFLAGS .
UOI_HEAPSIZE 5	Taille du tas de bureau, en Ko, sous forme de valeur ULONG . Le paramètre hObj doit être un handle pour un objet de bureau, sinon, la fonction échoue. Windows Server 2003 et Windows XP/2000 : Cette valeur n’est pas prise en charge.
UOI_IO 6	TRUE si le paramètre hObj est un handle pour l’objet de bureau qui reçoit une entrée de l’utilisateur. FALSE dans le cas contraire. Windows Server 2003 et Windows XP/2000 : Cette valeur n’est pas prise en charge.
UOI_NAME 2	Nom de l’objet, sous forme de chaîne.
UOI_TYPE 3	Nom de type de l’objet, sous forme de chaîne.
UOI_USER_SID 4	Structure SID qui identifie l’utilisateur actuellement associé à l’objet spécifié. Si aucun utilisateur n’est associé à l’objet, la valeur retournée dans la mémoire tampon pointée par lpnLengthNeeded est zéro. Notez que SID est une structure de longueur variable. Vous effectuez généralement un appel à GetUserObjectInformation pour déterminer la longueur du SID avant de récupérer sa valeur.

[out, optional] pvInfo

Pointeur vers une mémoire tampon pour recevoir les informations sur l’objet.

[in] nLength

Taille de la mémoire tampon pointée vers par le paramètre pvInfo , en octets.

[out, optional] lpnLengthNeeded

Pointeur vers une variable recevant le nombre d’octets requis pour stocker les informations demandées. Si la valeur de cette variable est supérieure à la valeur du paramètre nLength lorsque la fonction retourne, la fonction retourne FALSE et aucune des informations n’est copiée dans la mémoire tampon pvInfo . Si la valeur de la variable pointée par lpnLengthNeeded est inférieure ou égale à la valeur de nLength, le bloc d’informations entier est copié.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Notes

L’en-tête winuser.h définit GetUserObjectInformation en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winuser.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll
Ensemble d’API	ext-ms-win-ntuser-windowstation-ansi-l1-1-0 (introduit dans Windows 10, version 10.0.10240)