Função WTSLogoffSession (wtsapi32.h)

Faz logoff de uma sessão especificada dos Serviços de Área de Trabalho Remota.

Sintaxe

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

Parâmetros

[in] hServer

Um identificador para um servidor host de sessão de área de trabalho remota. Especifique um identificador aberto pela função WTSOpenServer ou WTSOpenServerEx ou especifique WTS_CURRENT_SERVER_HANDLE para indicar o servidor host da sessão rd no qual seu aplicativo está em execução.

[in] SessionId

Um identificador de sessão dos Serviços de Área de Trabalho Remota. Para indicar a sessão atual, especifique WTS_CURRENT_SESSION. Você pode usar a função WTSEnumerateSessions para recuperar os identificadores de todas as sessões em um servidor host de sessão rd especificado.

Para poder fazer logoff da sessão de outro usuário, você precisa ter a permissão Redefinir. Para obter mais informações, consulte Permissões dos Serviços de Área de Trabalho Remota. Para modificar permissões em uma sessão, use a ferramenta administrativa Configuração de Serviços de Área de Trabalho Remota.

Para fazer logoff das sessões em execução em uma máquina virtual hospedada em um servidor host de virtualização de área de trabalho remota, você deve ser membro do grupo Administradores no servidor host de virtualização de área de trabalho remota.

[in] bWait

Indica se a operação é síncrona.

Se bWait for TRUE, a função retornará quando a sessão for registrada.

Se bWait for FALSE, a função retornará imediatamente. Para verificar se a sessão foi registrada em log, especifique o identificador de sessão em uma chamada para a função WTSQuerySessionInformation . WTSQuerySessionInformation retornará zero se a sessão for registrada.

Retornar valor

Se a função for bem-sucedida, o valor retornado será um valor diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista
Servidor mínimo com suporte	Windows Server 2008
Plataforma de Destino	Windows
Cabeçalho	wtsapi32.h
Biblioteca	Wtsapi32.lib
DLL	Wtsapi32.dll
Conjunto de APIs	ext-ms-win-session-wtsapi32-l1-1-0 (introduzido em Windows 8)

Confira também

WTSEnumerateSessions

WTSQuerySessionInformation