Função WTSEnumerateSessionsA (wtsapi32.h)

Artigo
11/20/2024

Recupera uma lista de sessões em um servidor host de sessão da Área de Trabalho Remota (Host de Sessão de Área de Trabalho Remota).

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 rd.

Observação Você pode usar o WTSOpenServer ou funções de WTSOpenServerEx para recuperar um identificador para um servidor específico ou WTS_CURRENT_SERVER_HANDLE para usar o servidor host de 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 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 de WTS_SESSION_INFO retornadas no parâmetro ppSessionInfo.

Valor de retorno

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.

Observações

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista
servidor com suporte mínimo	Windows Server 2008
da Plataforma de Destino	Windows
cabeçalho	wtsapi32.h
biblioteca	Wtsapi32.lib
de DLL	Wtsapi32.dll
conjunto de API	ext-ms-win-session-wtsapi32-l1-1-0 (introduzido no Windows 8)

Consulte também

WTS_SESSION_INFO

Compartilhar via