Compartilhar via


Função WTSEnumerateServersA (wtsapi32.h)

Retorna uma lista de todos os servidores do Host da Sessão da Área de Trabalho Remota (Host de Sessão de Área de Trabalho Remota) dentro do domínio especificado.

Sintaxe

BOOL WTSEnumerateServersA(
  [in] LPSTR             pDomainName,
  [in] DWORD             Reserved,
  [in] DWORD             Version,
       PWTS_SERVER_INFOA *ppServerInfo,
       DWORD             *pCount
);

Parâmetros

[in] pDomainName

Ponteiro para o nome do domínio a ser consultado. Se o valor desse parâmetro for NULL, o domínio especificado será o domínio atual.

[in] Reserved

Reservado. O valor desse parâmetro deve ser 0.

[in] Version

Versão da solicitação de enumeração. O valor do parâmetro deve ser 1.

ppServerInfo

Aponta para uma matriz de estruturas de WTS_SERVER_INFO, que contém os resultados retornados da enumeração. Após o uso, a memória usada por esse buffer deve ser liberada chamando WTSFreeMemory.

pCount

Ponteiro para uma variável que recebe o número de estruturas de WTS_SERVER_INFO retornadas no buffer de ppServerInfo .

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

Essa função não funcionará se o NetBT estiver desabilitado.

Nota

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

Consulte também

WTS_SERVER_INFO