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

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

Синтаксис

BOOL WTSEnumerateListenersW(
  [in]            HANDLE            hServer,
  [in]            PVOID             pReserved,
  [in]            DWORD             Reserved,
  [out, optional] PWTSLISTENERNAMEW 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