WTSCreateListenerA 函数 (wtsapi32.h)

创建新的远程桌面服务侦听器或配置现有侦听器。

语法

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

参数

[in] hServer

RD 会话主机服务器的句柄。 始终将此参数设置为 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 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows 7
支持的最低服务器 Windows Server 2008 R2
目标平台 窗户
标头 wtsapi32.h
Wtsapi32.lib
DLL Wtsapi32.dll

另请参阅

SECURITY_DESCRIPTOR

SECURITY_INFORMATION

WTSLISTENERCONFIG

WTSSetListenerSecurity