Función WTSQuerySessionInformationA (wtsapi32.h)
Recupera la información de sesión de la sesión especificada en el servidor de host de sesión de Escritorio remoto (host de sesión de Escritorio remoto) especificado. Se puede usar para consultar información de sesión en servidores host de sesión de Escritorio remoto y local.
Sintaxis
BOOL WTSQuerySessionInformationA(
[in] HANDLE hServer,
[in] DWORD SessionId,
[in] WTS_INFO_CLASS WTSInfoClass,
[out] LPSTR *ppBuffer,
[out] DWORD *pBytesReturned
);
Parámetros
[in] hServer
Identificador de un servidor host de sesión de Escritorio remoto. Especifique un identificador abierto por la función WTSOpenServer de
[in] SessionId
Identificador de sesión de Servicios de Escritorio remoto. Para indicar la sesión en la que se ejecuta la aplicación que realiza la llamada (o la sesión actual), especifique WTS_CURRENT_SESSION. Especifique solo WTS_CURRENT_SESSION al obtener información de sesión en el servidor local. Si se especifica WTS_CURRENT_SESSION al consultar información de sesión en un servidor remoto, la información de sesión devuelta será incoherente. No use los datos devueltos.
Puede usar la función
Para consultar la información de la sesión de otro usuario, debe tener el permiso Información de consulta. Para obtener más información, consulte permisos de Servicios de Escritorio remoto. Para modificar permisos en una sesión, use la herramienta administrativa Configuración de Servicios de Escritorio remoto.
[in] WTSInfoClass
Valor de la enumeración
[out] ppBuffer
Puntero a una variable que recibe un puntero a la información solicitada. El formato y el contenido de los datos dependen de la clase de información especificada en el parámetro WTSInfoClass de
[out] pBytesReturned
Puntero a una variable que recibe el tamaño, en bytes, de los datos devueltos en ppBuffer.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.
Si se produce un error en la función, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.
Observaciones
Para recuperar el identificador de sesión de la sesión actual cuando se ejecuta Servicios de Escritorio remoto, llame a
Para determinar si la aplicación se ejecuta en la consola física, debe especificar
Nota
El encabezado wtsapi32.h define WTSQuerySessionInformation 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 Conventions for Function Prototypes.
Requisitos
Requisito | Valor |
---|---|
cliente mínimo admitido | Windows Vista |
servidor mínimo admitido | Windows Server 2008 |
de la plataforma de destino de |
Windows |
encabezado de |
wtsapi32.h |
biblioteca de |
Wtsapi32.lib |
DLL de |
Wtsapi32.dll |
conjunto de API de |
ext-ms-win-session-wtsapi32-l1-1-0 (introducido en Windows 8) |