WTSEnumerateSessionsW 函数 (wtsapi32.h)

  • 项目

检索远程桌面会话主机 (RD 会话主机) 服务器上的会话列表。

语法

BOOL WTSEnumerateSessionsW(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOW *ppSessionInfo,
  [out] DWORD              *pCount
);

参数

[in] hServer

RD 会话主机服务器的句柄。

注意 可以使用 WTSOpenServer 或 WTSOpenServerEx 函数检索特定服务器的句柄， 或者WTS_CURRENT_SERVER_HANDLE 使用托管应用程序的 RD 会话主机服务器。
 

[in] Reserved

此参数为保留参数。 它必须为零。

[in] Version

枚举请求的版本。 此参数必须为 1。

[out] ppSessionInfo

指向表示检索的会话 的WTS_SESSION_INFO 结构的数组的指针。 若要释放返回的缓冲区，请调用 WTSFreeMemory 函数。

会话权限：

  • 若要枚举会话，必须启用查询信息权限。 有关详细信息，请参阅 远程桌面服务权限。
  • 若要更改会话的权限，请使用远程桌面服务配置管理工具。
  • 若要枚举在 RD 虚拟化主机服务器上托管的虚拟机上运行的会话，你必须是 RD 虚拟化主机服务器上的 Administrators 组的成员。

[out] pCount

指向 ppSessionInfo 参数中返回的WTS_SESSION_INFO结构数的指针。

返回值

如果此函数失败，则返回零。 如果此函数成功，则返回非零值。

要获得更多的错误信息，请调用 GetLastError。

注解

注意

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

要求

   
最低受支持的客户端 Windows Vista
最低受支持的服务器 Windows Server 2008
目标平台 Windows
标头 wtsapi32.h
Library Wtsapi32.lib
DLL Wtsapi32.dll
API 集 windows 8 中引入的 ext-ms-win-session-wtsapi32-l1-1-0 ()

另请参阅

WTS_SESSION_INFO