Função WTSCreateListenerA (wtsapi32.h)

Artigo
11/20/2024

Cria um novo ouvinte dos Serviços de Área de Trabalho Remota ou configura um ouvinte existente.

Sintaxe

BOOL WTSCreateListenerA(
  [in] HANDLE              hServer,
  [in] PVOID               pReserved,
  [in] DWORD               Reserved,
  [in] LPSTR               pListenerName,
  [in] PWTSLISTENERCONFIGA pBuffer,
  [in] DWORD               flag
);

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.

[in] pListenerName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do ouvinte a ser criado ou configurado.

[in] pBuffer

Um ponteiro para uma estrutura WTSLISTENERCONFIG que contém informações de configuração para o ouvinte.

[in] flag

A finalidade da chamada. Esse parâmetro pode ser um dos valores a seguir.

WTS_LISTENER_CREATE (1 (0x1))

Crie um ouvinte.

WTS_LISTENER_UPDATE (16 (0x10))

Atualize as configurações de um ouvinte existente.

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

Essa função cria ou configura um ouvinte que usa RDP (Remote Desktop Protocol). Sempre defina a versão membro da estrutura de WTSLISTENERCONFIG que é apontada pelo parâmetro pBuffer como um.

Essa função não cria ou configura o descritor de segurança do ouvinte. Quando você chama essa função para criar um ouvinte, a função atribui o descritor de segurança padrão ao novo ouvinte. Para modificar o descritor de segurança, chame a função WTSSetListenerSecurity. Para obter mais informações sobre descritores de segurança, consulte SECURITY_DESCRIPTOR.

Essa função não valida as configurações do novo ouvinte. Verifique se as configurações são válidas antes de chamar essa função.

Nota

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

Consulte também

SECURITY_DESCRIPTOR

SECURITY_INFORMATION

WTSLISTENERCONFIG

WTSSetListenerSecurity

Compartilhar via