Função WTSEnumerateListenersA (wtsapi32.h)

Artigo
11/20/2024

Enumera todos os ouvintes dos Serviços de Área de Trabalho Remota em um servidor de Host de Sessão da Área de Trabalho Remota (Host de Sessão de Área de Trabalho Remota).

Sintaxe

BOOL WTSEnumerateListenersA(
  [in]            HANDLE            hServer,
  [in]            PVOID             pReserved,
  [in]            DWORD             Reserved,
  [out, optional] PWTSLISTENERNAMEA pListeners,
  [in, out]       DWORD             *pCount
);

Parâmetros

[in] hServer

Um identificador para um servidor host de sessão de área de trabalho remota. Sempre defina esse parâmetro como WTS_CURRENT_SERVER_HANDLE.

[in] pReserved

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

[in] Reserved

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

[out, optional] pListeners

Um ponteiro para uma matriz de variáveis WTSLISTENERNAME que recebem os nomes dos ouvintes.

[in, out] pCount

Um ponteiro para uma variável DWORD que contém o número de nomes de ouvintes na matriz referenciada pelo parâmetro pListeners. Se o número de nomes de ouvintes for desconhecido, passe pListeners como NULL. A função retornará o número de variáveis WTSLISTENERNAME necessárias para alocar para a matriz apontada pelo parâmetro pListeners .

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 retorna todos os ouvintes atualmente em execução no servidor, incluindo ouvintes que não dão suporte ao RDP (Protocolo de Área de Trabalho Remota).

Se o número de ouvintes for desconhecido, você poderá chamar essa função com pListeners definido como NULL. Em seguida, a função retornará, no parâmetro pCount, o número de variáveis WTSLISTENERNAME necessárias para receber todos os ouvintes. Aloque a matriz para pListeners com base nesse número e chame a função novamente, definindo pListeners para a matriz recém-alocada e pCount para o número retornado pela primeira chamada.

Nota

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

Compartilhar via