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

Статья
08/28/2023

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

Синтаксис

BOOL WTSCreateListenerW(
  [in] HANDLE              hServer,
  [in] PVOID               pReserved,
  [in] DWORD               Reserved,
  [in] LPWSTR              pListenerName,
  [in] PWTSLISTENERCONFIGW 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 , равным 1.

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

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

Примечание

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

Требования

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