Función WTSEnumerateSessionsA (wtsapi32.h)

  • Artículo

Recupera una lista de sesiones en un servidor host de sesión de Escritorio remoto (host de sesión de Escritorio remoto).

Sintaxis

BOOL WTSEnumerateSessionsA(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOA *ppSessionInfo,
  [out] DWORD              *pCount
);

Parámetros

[in] hServer

Identificador del servidor host de sesión de Escritorio remoto.

Nota Puede usar las funciones WTSOpenServer o WTSOpenServerEx para recuperar un identificador de un servidor específico o WTS_CURRENT_SERVER_HANDLE para usar el servidor host de sesión de Escritorio remoto que hospeda la aplicación.
 

[in] Reserved

Este parámetro está reservado. Debe ser cero.

[in] Version

Versión de la solicitud de enumeración. Este parámetro debe ser 1.

[out] ppSessionInfo

Puntero a una matriz de estructuras de WTS_SESSION_INFO que representan las sesiones recuperadas. Para liberar el búfer devuelto, llame a la función WTSFreeMemory .

Permisos de sesión:

  • Para enumerar una sesión, debe habilitar el permiso de información de consulta. Para obtener más información, consulte Permisos de Servicios de Escritorio remoto.
  • Para cambiar los permisos en una sesión, use la herramienta administrativa Configuración de Servicios de Escritorio remoto.
  • Para enumerar las sesiones que se ejecutan en una máquina virtual hospedada en un servidor host de virtualización de Escritorio remoto, debe ser miembro del grupo Administradores en el servidor host de virtualización de Escritorio remoto.

[out] pCount

Puntero al número de estructuras de WTS_SESSION_INFO devueltas en el parámetro ppSessionInfo .

Valor devuelto

Devuelve cero si se produce un error en esta función. Si esta función se ejecuta correctamente, se devuelve un valor distinto de cero.

Para obtener información de error extendida, llame a GetLastError.

Comentarios

Nota

El encabezado wtsapi32.h define WTSEnumerateSessions 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en 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 Vista
Servidor mínimo compatible Windows Server 2008
Plataforma de destino Windows
Encabezado wtsapi32.h
Library Wtsapi32.lib
Archivo DLL Wtsapi32.dll
Conjunto de API ext-ms-win-session-wtsapi32-l1-1-0 (introducido en Windows 8)

Consulte también

WTS_SESSION_INFO