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

Статья
11/20/2024

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

Синтаксис

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
целевая платформа	Виндоус
заголовка	wtsapi32.h
библиотеки	Wtsapi32.lib
DLL	Wtsapi32.dll

Поделиться через