Función GetUserObjectInformationA (winuser.h)

Artículo
03/04/2024

Recupera información sobre la estación de ventana o el objeto de escritorio especificados.

Sintaxis

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

Parámetros

[in] hObj

Identificador de la estación de ventana o el objeto de escritorio. Este identificador lo devuelve la función CreateWindowStation, OpenWindowStation, CreateDesktop o OpenDesktop .

[in] nIndex

Información que se va a recuperar. El parámetro puede ser uno de los valores siguientes.

Valor	Significado
UOI_FLAGS 1	Marcas de identificador. El parámetro pvInfo debe apuntar a una estructura USEROBJECTFLAGS .
UOI_HEAPSIZE 5	Tamaño del montón de escritorio, en KB, como un valor de ULONG . El parámetro hObj debe ser un identificador para un objeto de escritorio; de lo contrario, se produce un error en la función. Windows Server 2003 y Windows XP/2000: Este valor no se admite.
UOI_IO 6	TRUE si el parámetro hObj es un identificador para el objeto de escritorio que recibe la entrada del usuario. False en caso contrario. Windows Server 2003 y Windows XP/2000: Este valor no se admite.
UOI_NAME 2	Nombre del objeto, como una cadena.
UOI_TYPE 3	Nombre de tipo del objeto, como una cadena.
UOI_USER_SID 4	Estructura del SID que identifica al usuario que está asociado actualmente al objeto especificado. Si ningún usuario está asociado al objeto , el valor devuelto en el búfer al que apunta lpnLengthNeeded es cero. Tenga en cuenta que el SID es una estructura de longitud variable. Normalmente, realizará una llamada a GetUserObjectInformation para determinar la longitud del SID antes de recuperar su valor.

[out, optional] pvInfo

Puntero a un búfer para recibir la información del objeto.

[in] nLength

Tamaño del búfer al que apunta el parámetro pvInfo , en bytes.

[out, optional] lpnLengthNeeded

Puntero a una variable que recibe el número de bytes necesarios para almacenar la información solicitada. Si el valor de esta variable es mayor que el valor del parámetro nLength cuando la función devuelve, la función devuelve FALSE y ninguna de las informaciones se copia en el búfer pvInfo . Si el valor de la variable a la que apunta lpnLengthNeeded es menor o igual que el valor de nLength, se copia todo el bloque de información.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Nota

El encabezado winuser.h define GetUserObjectInformation como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-windowstation-ansi-l1-1-0 (introducido en Windows 10, versión 10.0.10240)