Función WTSEnumerateListenersA (wtsapi32.h)

Enumera todos los agentes de escucha de Servicios de Escritorio remoto en un servidor host de sesión de Escritorio remoto (host de sesión de Escritorio remoto).

Sintaxis

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

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.

[out, optional] pListeners

Puntero a una matriz de WTSLISTENERNAME variables que reciben los nombres de los agentes de escucha.

[in, out] pCount

Puntero a una variable DWORD de que contiene el número de nombres de agente de escucha en la matriz a la que hace referencia el parámetro pListeners . Si se desconoce el número de nombres de agente de escucha, pase pListeners como NULL. La función devolverá el número de variables WTSLISTENERNAME necesarias para asignar la matriz a la que apunta el parámetro pListeners.

Valor devuelto

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

Si se produce un error en la función, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Observaciones

Esta función devuelve todos los agentes de escucha que se ejecutan actualmente en el servidor, incluidos los agentes de escucha que no admiten el Protocolo de escritorio remoto (RDP).

Si se desconoce el número de agentes de escucha, puede llamar a esta función con pListeners establecido en NULL. A continuación, la función devolverá, en el parámetro pCount, el número de WTSLISTENERNAME variables necesarias para recibir todos los agentes de escucha. Asigne la matriz para pListeners en función de este número y, a continuación, vuelva a llamar a la función, estableciendo pListeners en la matriz recién asignada y pCount al número devuelto por la primera llamada.

Nota

El encabezado wtsapi32.h define WTSEnumerateListeners 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 7
servidor mínimo admitido	Windows Server 2008 R2
de la plataforma de destino de	Windows
encabezado de	wtsapi32.h
biblioteca de	Wtsapi32.lib
DLL de	Wtsapi32.dll