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

Статья
11/20/2024

Создает новый прослушиватель служб удаленных рабочих столов или настраивает существующий прослушиватель.

Синтаксис

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

Параметры

[in] hServer

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

[in] pReserved

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

[in] Reserved

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

[in] pListenerName

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

[in] pBuffer

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

[in] flag

Назначение вызова. Этот параметр может быть одним из следующих значений.

WTS_LISTENER_CREATE (1 (0x1))

Создайте прослушиватель.

WTS_LISTENER_UPDATE (16 (0x10))

Обновите параметры существующего прослушивателя.

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

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

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

Замечания

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

Эта функция не создает или не настраивает дескриптор безопасности прослушивателя. При вызове этой функции для создания нового прослушивателя функция назначает дескриптор безопасности по умолчанию новому прослушивателю. Чтобы изменить дескриптор безопасности, вызовите функцию WTSSetListenerSecurity. Дополнительные сведения о дескрипторах безопасности см. в SECURITY_DESCRIPTOR.

Эта функция не проверяет параметры для нового прослушивателя. Перед вызовом этой функции убедитесь, что параметры допустимы.

Заметка

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

Требования

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