WTSEnumerateServersA 函数 (wtsapi32.h)

  • 项目

返回指定域中所有远程桌面会话主机 (RD 会话主机) 服务器的列表。

语法

BOOL WTSEnumerateServersA(
  [in] LPSTR             pDomainName,
  [in] DWORD             Reserved,
  [in] DWORD             Version,
       PWTS_SERVER_INFOA *ppServerInfo,
       DWORD             *pCount
);

参数

[in] pDomainName

指向要查询的域名称的指针。 如果此参数的值为 NULL，则指定的域是当前域。

[in] Reserved

保留。 此参数的值必须为 0。

[in] Version

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

ppServerInfo

指向包含枚举返回结果的 WTS_SERVER_INFO 结构的数组。 使用后，应通过调用 WTSFreeMemory 来释放此缓冲区使用的内存。

pCount

指向一个变量的指针，该变量接收 ppServerInfo 缓冲区中返回的WTS_SERVER_INFO结构数。

返回值

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

如果函数失败，则返回值为零。 要获得更多的错误信息，请调用 GetLastError。

注解

如果禁用 NetBT，此函数将不起作用。

注意

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

要求

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

另请参阅

WTS_SERVER_INFO