Función WTSCreateListenerA (wtsapi32.h)

Artículo
03/13/2024

Crea un nuevo agente de escucha de Servicios de Escritorio remoto o configura un agente de escucha existente.

Sintaxis

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

Parámetros

[in] hServer

Identificador de un servidor host de sesión de Escritorio remoto. Establezca siempre este parámetro en WTS_CURRENT_SERVER_HANDLE.

[in] pReserved

Este parámetro está reservado. Establezca siempre este parámetro en NULL.

[in] Reserved

Este parámetro está reservado. Establezca siempre este parámetro en cero.

[in] pListenerName

Puntero a una cadena terminada en null que contiene el nombre del agente de escucha que se va a crear o configurar.

[in] pBuffer

Puntero a una estructura WTSLISTENERCONFIG que contiene información de configuración para el agente de escucha.

[in] flag

Propósito de la llamada. Este parámetro puede ser uno de los valores siguientes.

WTS_LISTENER_CREATE (1 (0x1))

Cree un nuevo agente de escucha.

WTS_LISTENER_UPDATE (16 (0x10))

Actualice la configuración de un agente de escucha existente.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información ampliada de los errores, llame a la función GetLastError.

Comentarios

Esta función crea o configura un agente de escucha que usa el Protocolo de escritorio remoto (RDP). Establezca siempre el miembro de versión de la estructura WTSLISTENERCONFIG a la que apunta el parámetro pBuffer en uno.

Esta función no crea ni configura el descriptor de seguridad del agente de escucha. Al llamar a esta función para crear un nuevo agente de escucha, la función asigna el descriptor de seguridad predeterminado al nuevo agente de escucha. Para modificar el descriptor de seguridad, llame a la función WTSSetListenerSecurity . Para obtener más información sobre los descriptores de seguridad, consulte SECURITY_DESCRIPTOR.

Esta función no valida la configuración del nuevo agente de escucha. Asegúrese de que la configuración es válida antes de llamar a esta función.

Nota

El encabezado wtsapi32.h define WTSCreateListener como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7
Servidor mínimo compatible	Windows Server 2008 R2
Plataforma de destino	Windows
Encabezado	wtsapi32.h
Library	Wtsapi32.lib
Archivo DLL	Wtsapi32.dll