estrutura WTS_SESSION_INFO_1A (wtsapi32.h)

Artigo
11/20/2024

Contém informações estendidas sobre uma sessão de cliente em um servidor host de sessão da Área de Trabalho Remota (Host de Sessão de Área de Trabalho Remota) ou servidor do Host de Virtualização de Área de Trabalho Remota (Host de Virtualização de Área de Trabalho Remota).

Sintaxe

typedef struct _WTS_SESSION_INFO_1A {
  DWORD                  ExecEnvId;
  WTS_CONNECTSTATE_CLASS State;
  DWORD                  SessionId;
  LPSTR                  pSessionName;
  LPSTR                  pHostName;
  LPSTR                  pUserName;
  LPSTR                  pDomainName;
  LPSTR                  pFarmName;
} WTS_SESSION_INFO_1A, *PWTS_SESSION_INFO_1A;

Membros

ExecEnvId

Um identificador que identifica exclusivamente a sessão na lista de sessões retornadas pela função WTSEnumerateSessionsEx. Para obter mais informações, consulte Comentários.

State

Um valor do tipo de enumeração WTS_CONNECTSTATE_CLASS que especifica o estado de conexão de uma sessão dos Serviços de Área de Trabalho Remota.

SessionId

Um identificador de sessão atribuído pelo servidor host da sessão rd, servidor host de virtualização de área de trabalho remota ou máquina virtual.

pSessionName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome desta sessão. Por exemplo, "serviços", "console" ou "RDP-Tcp#0".

pHostName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do computador no qual a sessão está sendo executada. Se a sessão estiver sendo executada diretamente em um servidor host de sessão rd ou servidor host de virtualização de área de trabalho remota, a cadeia de caracteres conterá NULL. Se a sessão estiver em execução em uma máquina virtual, a cadeia de caracteres conterá o nome da máquina virtual.

pUserName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do usuário que está conectado à sessão. Se nenhum usuário estiver conectado à sessão, a cadeia de caracteres conterá NULL.

pDomainName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome de domínio do usuário que está conectado à sessão. Se nenhum usuário estiver conectado à sessão, a cadeia de caracteres conterá NULL.

pFarmName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do farm ao qual a máquina virtual está unida. Se a sessão não estiver em execução em uma máquina virtual ingressada em um farm, a cadeia de caracteres conterá NULL.

Observações

A função WTSEnumerateSessionsEx retornará essa estrutura se você chamar a função e especificar um identificador para um servidor host de virtualização de área de trabalho remota obtido chamando a função WTSOpenServerEx . Nesse caso, a função WTSEnumerateSessionsEx agrega todas as sessões em execução no próprio host, bem como sessões em execução em máquinas virtuais individuais. O parâmetro ExecEnvId identifica exclusivamente cada sessão na lista agregada. Esse identificador pode ser diferente do identificador de sessão real definido no servidor ou na máquina virtual que hospeda a sessão, que é especificada pelo membro SessionId.

A sessão representada por essa estrutura pode ser uma sessão em execução diretamente no servidor ou em uma sessão em execução em uma máquina virtual. Se a sessão estiver em execução em uma máquina virtual, o membro pHostName conterá o nome da máquina virtual. O membro pFarmName é aplicável a sessões hospedadas em máquinas virtuais ingressadas em um farm de Host de Sessão de Área de Trabalho Remota.

Nota

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

Consulte também

WTSEnumerateSessionsEx

WTS_SESSION_INFO

Compartilhar via