Função WTSEnumerateSessionsExA (wtsapi32.h)

Artigo
11/20/2024

Recupera uma lista de sessões em um servidor do Host de Sessão da Área de Trabalho Remota (Host de Sessão de Área de Trabalho Remota) especificado ou no servidor do Host de Virtualização de Área de Trabalho Remota (Host de Virtualização de Área de Trabalho Remota).

Sintaxe

BOOL WTSEnumerateSessionsExA(
  [in]      HANDLE               hServer,
  [in, out] DWORD                *pLevel,
  [in]      DWORD                Filter,
  [out]     PWTS_SESSION_INFO_1A *ppSessionInfo,
  [out]     DWORD                *pCount
);

Parâmetros

[in] hServer

Um identificador para o servidor de destino. Especifique um identificador retornado pela WTSOpenServer ou função WTSOpenServerEx. Para enumerar sessões no servidor host da sessão rd no qual o aplicativo está em execução, especifique WTS_CURRENT_SERVER_HANDLE.

[in, out] pLevel

Esse parâmetro é reservado. Sempre defina esse parâmetro como um. Na saída, WTSEnumerateSessionsEx não altera o valor desse parâmetro.

[in] Filter

Esse parâmetro é reservado. Sempre defina esse parâmetro como zero.

[out] ppSessionInfo

Um ponteiro para uma variável de PWTS_SESSION_INFO_1 que recebe um ponteiro para uma matriz de estruturas de WTS_SESSION_INFO_1. Cada estrutura na matriz contém informações sobre uma sessão no servidor host de sessão rd especificado. Se você obteve um identificador para um servidor host de Virtualização de Área de Trabalho Remota chamando a função WTSOpenServerEx, a matriz conterá informações sobre sessões em máquinas virtuais no servidor. Quando terminar de usar a matriz, libere-a chamando a função WTSFreeMemoryEx. Você também deve definir o ponteiro para NULL.

[out] pCount

Um ponteiro para uma variável DWORD que recebe o número de estruturas WTS_SESSION_INFO_1 retornadas no buffer ppSessionInfo .

Valor de retorno

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 a função GetLastError.

Observações

Para obter informações sobre sessões em execução em máquinas virtuais em um servidor Host de Virtualização de Área de Trabalho Remota, você deve obter o identificador chamando a função WTSOpenServerEx. Para liberar o buffer retornado, chame a função WTSFreeMemoryEx e defina o parâmetro WTSClassType para WTSTypeSessionInfoLevel1.

Para enumerar uma sessão, você precisa ter a permissão Informações de Consulta para essa sessão. 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 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.

Nota

O cabeçalho wtsapi32.h define WTSEnumerateSessionsEx 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 7
servidor com suporte mínimo	Windows Server 2008 R2
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

WTSFreeMemoryEx

WTSOpenServerEx

WTS_SESSION_INFO_1

Compartilhar via