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 variables WTSLISTENERNAME que reciben los nombres de los agentes de escucha.
[in, out] pCount
Puntero a una variable DWORD 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 la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.
Comentarios
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 variables WTSLISTENERNAME necesarias para recibir todos los agentes de escucha. Asigne la matriz para pListeners en función de este número y, a continuación, llame a la función de nuevo, estableciendo pListeners en la matriz recién asignada y pCount en el 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 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 |