Функция WTSEnumerateListenersA (wtsapi32.h)

Перечисляет все прослушиватели служб удаленных рабочих столов на сервере узла сеансов удаленных рабочих столов (узел сеансов удаленных рабочих столов).

Синтаксис

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

Параметры

[in] hServer

Дескриптор сервера узла сеансов удаленных рабочих стола. Всегда присвойте этому параметру значение WTS_CURRENT_SERVER_HANDLE.

[in] pReserved

Этот параметр зарезервирован. Всегда присваивайте этому параметру значение NULL.

[in] Reserved

Этот параметр зарезервирован. Всегда присвойте этому параметру нулевое значение.

[out, optional] pListeners

Указатель на массив переменных WTSLISTENERNAME , получающих имена прослушивателей.

[in, out] pCount

Указатель на переменную DWORD , содержащую количество имен прослушивателей в массиве, на который ссылается параметр pListeners . Если число имен прослушивателей неизвестно, передайте pListeners как NULL. Функция возвращает количество переменных WTSLISTENERNAME , необходимых для выделения массива, на который указывает параметр pListeners .

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет ненулевым.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Эта функция возвращает все прослушиватели, запущенные в данный момент на сервере, включая прослушиватели, которые не поддерживают протокол удаленного рабочего стола (RDP).

Если число прослушивателей неизвестно, эту функцию можно вызвать, если для pListeners задано значение NULL. Затем функция возвращает в параметре pCount количество переменных WTSLISTENERNAME , необходимое для получения всех прослушивателей. Выделите массив для pListeners на основе этого числа, а затем снова вызовите функцию, задав pListeners только что выделенный массив, а pCount — номер, возвращенный первым вызовом.

Примечание

Заголовок wtsapi32.h определяет WTSEnumerateListeners как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 7
Минимальная версия сервера	Windows Server 2008 R2
Целевая платформа	Windows
Header	wtsapi32.h
Библиотека	Wtsapi32.lib
DLL	Wtsapi32.dll