Função WTSQuerySessionInformationA (wtsapi32.h)

Artigo
11/20/2024

Recupera informações de sessão para a sessão especificada no servidor do Host da Sessão da Área de Trabalho Remota (Host de Sessão de Área de Trabalho Remota) especificado. Ele pode ser usado para consultar informações de sessão em servidores host de sessão rd locais e remotos.

Sintaxe

BOOL WTSQuerySessionInformationA(
  [in]  HANDLE         hServer,
  [in]  DWORD          SessionId,
  [in]  WTS_INFO_CLASS WTSInfoClass,
  [out] LPSTR          *ppBuffer,
  [out] DWORD          *pBytesReturned
);

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 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 na qual o aplicativo de chamada está em execução (ou a sessão atual) especifique WTS_CURRENT_SESSION. Especifique apenas WTS_CURRENT_SESSION ao obter informações de sessão no servidor local. Se WTS_CURRENT_SESSION for especificado ao consultar informações de sessão em um servidor remoto, as informações de sessão retornadas serão inconsistentes. Não use os dados retornados.

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 consultar informações sobre a sessão de outro usuário, você deve ter a permissão Informações de Consulta. 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.

[in] WTSInfoClass

Um valor da enumeração WTS_INFO_CLASS que indica o tipo de informações de sessão a serem recuperadas em uma chamada para a função WTSQuerySessionInformation.

[out] ppBuffer

Um ponteiro para uma variável que recebe um ponteiro para as informações solicitadas. O formato e o conteúdo dos dados dependem da classe de informações especificada no parâmetro WTSInfoClass. Para liberar o buffer retornado, chame a função WTSFreeMemory.

[out] pBytesReturned

Um ponteiro para uma variável que recebe o tamanho, em bytes, dos dados retornados em ppBuffer.

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

Observações

Para recuperar a ID da sessão atual quando os Serviços de Área de Trabalho Remota estiverem em execução, chame WTSQuerySessionInformation e especifique WTS_CURRENT_SESSION para o parâmetro SessionId e WTSSessionId para o parâmetro WTSInfoClass. A ID da sessão será retornada no parâmetro ppBuffer. Se os Serviços de Área de Trabalho Remota não estiverem em execução, as chamadas para WTSQuerySessionInformation falhar. Nessa situação, você pode recuperar a ID da sessão atual chamando a função ProcessIdToSessionId.

Para determinar se o aplicativo está em execução no console físico, você deve especificar WTS_CURRENT_SESSION para o parâmetro SessionId e WTSClientProtocolType como o parâmetro WTSInfoClass . Se ppBuffer for "0", a sessão será anexada ao console físico.

Nota

O cabeçalho wtsapi32.h define WTSQuerySessionInformation 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)