通过

WTSEnumerateListenersA 函数 （wtsapi32.h）

  • 项目

枚举远程桌面会话主机（RD 会话主机）服务器上的所有远程桌面服务侦听器。

语法

BOOL WTSEnumerateListenersA(
  [in]            HANDLE            hServer,
  [in]            PVOID             pReserved,
  [in]            DWORD             Reserved,
  [out, optional] PWTSLISTENERNAMEA pListeners,
  [in, out]       DWORD             *pCount
);

参数

[in] hServer

RD 会话主机服务器的句柄。 始终将此参数设置为 WTS_CURRENT_SERVER_HANDLE。

[in] pReserved

此参数保留。 始终将此参数设置为 NULL。

[in] Reserved

此参数保留。 始终将此参数设置为零。

[out, optional] pListeners

指向接收侦听器名称的 WTSLISTENERNAME 变量的指针。

[in, out] pCount

指向 DWORD 变量的指针，该变量包含由 pListeners 参数引用的数组中的侦听器名称数。 如果侦听器名称数未知，请将 pListeners 作为 NULL传递。 该函数将返回为 pListeners 参数指向的数组分配所需的 WTSLISTENERNAME 变量的数目。

返回值

如果函数成功，则返回值为非零值。

如果函数失败，则返回值为零。 若要获取扩展的错误信息，请调用 GetLastError。

言论

此函数返回当前在服务器上运行的所有侦听器，包括不支持远程桌面协议（RDP）的侦听器。

如果侦听器数未知，则可以调用此函数，pListeners 设置为 NULL。 然后，该函数将在 pCount 参数中返回 WTSLISTENERNAME 接收所有侦听器所需的变量数。 根据此数字为 pListeners 分配数组，然后再次调用该函数，将 pListeners 设置为新分配的数组，并将 pCount 设置为第一次调用返回的数字 pCount。

注意

wtsapi32.h 标头将 WTSEnumerateListeners 定义为一个别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息，请参阅函数原型的 约定。

要求

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