Função WTSEnumerateSessionsA (wtsapi32.h)

  • Artigo

Recupera uma lista de sessões em um servidor host de sessão de área de trabalho remota (host de sessão rd).

Sintaxe

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

Parâmetros

[in] hServer

Um identificador para o servidor Host da Sessão de Área de Trabalho Remota.

Nota Você pode usar as funções WTSOpenServer ou WTSOpenServerEx para recuperar um identificador para um servidor específico ou WTS_CURRENT_SERVER_HANDLE para usar o servidor host da sessão rd que hospeda seu aplicativo.
 

[in] Reserved

Esse parâmetro é reservado. Deve ser zero.

[in] Version

A versão da solicitação de enumeração. Esse parâmetro deve ser 1.

[out] ppSessionInfo

Um ponteiro para uma matriz de estruturas de WTS_SESSION_INFO que representam as sessões recuperadas. Para liberar o buffer retornado, chame a função WTSFreeMemory .

Permissões de sessão:

  • Para enumerar uma sessão, você deve habilitar a permissão de informações de consulta. Para obter mais informações, consulte Permissões dos Serviços de Área de Trabalho Remota.
  • Para alterar as permissões em uma sessão, use a ferramenta administrativa Configuração de Serviços de Área de Trabalho Remota.
  • Para enumerar 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.

[out] pCount

Um ponteiro para o número de estruturas WTS_SESSION_INFO retornadas no parâmetro ppSessionInfo .

Retornar valor

Retornará zero se essa função falhar. Se essa função for bem-sucedida, um valor diferente de zero será retornado.

Para obter informações de erro estendidas, chame GetLastError.

Comentários

Observação

O cabeçalho wtsapi32.h define WTSEnumerateSessions como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

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

WTS_SESSION_INFO