通过

WTSQueryUserConfigA 函数 (wtsapi32.h)

  • 项目

检索指定域控制器或远程桌面会话主机 (RD 会话主机) 服务器上的指定用户的配置信息。

语法

BOOL WTSQueryUserConfigA(
  [in]  LPSTR            pServerName,
  [in]  LPSTR            pUserName,
  [in]  WTS_CONFIG_CLASS WTSConfigClass,
  [out] LPSTR            *ppBuffer,
  [out] DWORD            *pBytesReturned
);

参数

[in] pServerName

指向以 null 结尾的字符串的指针，该字符串包含域控制器或 RD 会话主机服务器的名称。 指定 WTS_CURRENT_SERVER_NAME 以指示运行应用程序的 RD 会话主机服务器。

[in] pUserName

指向包含要查询的用户名的以 null 结尾的字符串的指针。 若要检索 RD 会话主机服务器的默认设置，请将此参数设置为 NULL。

Windows Server 2008 和 Windows Vista： 将此参数设置为 NULL 将返回错误。

[in] WTSConfigClass

指定要检索的信息的类型。 此参数可以是 WTS_CONFIG_CLASS 枚举类型的值之一。 WTS_CONFIG_CLASS文档介绍了 ppBuffer 中针对每种信息类型返回的数据的格式。

[out] ppBuffer

指向接收指向所请求信息的指针的变量的指针的指针。 数据的格式和内容取决于 WTSConfigClass 参数中指定的信息类。 若要释放返回的缓冲区，请调用 WTSFreeMemory 函数。

[out] pBytesReturned

指向一个变量的指针，该变量接收 ppBuffer 中返回的数据的大小（以字节为单位）。

返回值

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

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

注解

WTSQueryUserConfig 和 WTSSetUserConfig 函数传递服务器名称而不是句柄，因为用户帐户信息通常驻留在域控制器上。 若要设置用户配置信息，请使用主域控制器。 可以调用 NetGetDCName 函数来获取主域控制器的名称。 若要查询用户配置信息，可以使用 NetGetAnyDCName 函数获取主域控制器或备份域控制器的名称。

任何域控制器都可以设置或查询用户配置信息。 使用 DsGetDcName 函数检索域控制器的名称。

注意

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

要求

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

另请参阅

WTSFreeMemory

WTSSetUserConfig

WTS_CONFIG_CLASS