Función WTSDisconnectSession (wtsapi32.h)

  • Artículo

Desconecta el usuario que ha iniciado sesión de la sesión de Servicios de Escritorio remoto especificada sin cerrar la sesión. Si el usuario inicia sesión posteriormente en el mismo servidor host de sesión de Escritorio remoto (host de sesión de Escritorio remoto), el usuario se vuelve a conectar a la misma sesión.

Sintaxis

BOOL WTSDisconnectSession(
  [in] HANDLE hServer,
  [in] DWORD  SessionId,
  [in] BOOL   bWait
);

Parámetros

[in] hServer

Identificador de un servidor host de sesión de Escritorio remoto. Especifique un identificador abierto por la función WTSOpenServer o WTSOpenServerEx , o especifique WTS_CURRENT_SERVER_HANDLE para indicar el servidor host de sesión de Escritorio remoto en el que se ejecuta la aplicación.

[in] SessionId

Identificador de sesión de Servicios de Escritorio remoto. Para indicar la sesión actual, especifique WTS_CURRENT_SESSION. Para recuperar los identificadores de todas las sesiones en un servidor host de sesión de Escritorio remoto especificado, use la función WTSEnumerateSessions .

Para poder desconectar la sesión de otro usuario, debe tener el permiso Desconectar. Para obtener más información, vea Permisos de Servicios de Escritorio remoto. Para modificar permisos en una sesión, use la herramienta administrativa Configuración de Servicios de Escritorio remoto.

Para desconectar 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.

[in] bWait

Indica si la operación es sincrónica. Especifique TRUE para esperar a que se complete la operación o FALSE para que se devuelva inmediatamente.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor 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.

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

WTSEnumerateSessions