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

Статья
11/20/2024

Извлекает сведения о конфигурации прослушивателя служб удаленных рабочих столов.

Синтаксис

BOOL WTSQueryListenerConfigA(
  [in]  HANDLE              hServer,
  [in]  PVOID               pReserved,
  [in]  DWORD               Reserved,
  [in]  LPSTR               pListenerName,
  [out] PWTSLISTENERCONFIGA pBuffer
);

Параметры

[in] hServer

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

[in] pReserved

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

[in] Reserved

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

[in] pListenerName

Указатель на строку, завершающуюся значением NULL, которая содержит имя прослушивателя для запроса.

[out] pBuffer

Указатель на структуру WTSLISTENERCONFIG, которая получает полученные сведения о конфигурации прослушивателя.

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

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

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

Замечания

Эта функция не извлекает дескриптор безопасности для прослушивателя. Чтобы получить дескриптор безопасности, вызовите функцию WTSGetListenerSecurity.

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 7
минимальный поддерживаемый сервер	Windows Server 2008 R2
целевая платформа	Виндоус
заголовка	wtsapi32.h
библиотеки	Wtsapi32.lib
DLL	Wtsapi32.dll

См. также

WTSGetListenerSecurity

WTSLISTENERCONFIG

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