Export (0) Print
Expand All
Expand Minimize
2 out of 2 rated this helpful - Rate this topic

WTSQueryUserConfig function

Retrieves configuration information for the specified user on the specified domain controller or Remote Desktop Session Host (RD Session Host) server.

Syntax


BOOL WTSQueryUserConfig(
  _In_   LPTSTR pServerName,
  _In_   LPTSTR pUserName,
  _In_   WTS_CONFIG_CLASS WTSConfigClass,
  _Out_  LPTSTR *ppBuffer,
  _Out_  DWORD *pBytesReturned
);

Parameters

pServerName [in]

Pointer to a null-terminated string containing the name of a domain controller or an RD Session Host server. Specify WTS_CURRENT_SERVER_NAME to indicate the RD Session Host server on which your application is running.

pUserName [in]

Pointer to a null-terminated string containing the user name to query. To retrieve the default user settings for the RD Session Host server, set this parameter to NULL.

Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP:  Setting this parameter to NULL returns an error.

WTSConfigClass [in]

Specifies the type of information to retrieve. This parameter can be one of the values from the WTS_CONFIG_CLASS enumeration type. The documentation for WTS_CONFIG_CLASS describes the format of the data returned in ppBuffer for each of the information types.

ppBuffer [out]

Pointer to a variable that receives a pointer to the requested information. The format and contents of the data depend on the information class specified in the WTSConfigClass parameter. To free the returned buffer, call the WTSFreeMemory function.

pBytesReturned [out]

Pointer to a variable that receives the size, in bytes, of the data returned in ppBuffer.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The WTSQueryUserConfig and WTSSetUserConfig functions are passed a server name instead of a handle because user account information often resides on a domain controller. To set user configuration information, use the primary domain controller. You can call the NetGetDCName function to get the name of the primary domain controller. To query user configuration information, you can use the NetGetAnyDCName function to get the name of a primary or backup domain controller.

Any domain controller can set or query user configuration information. Use the DsGetDcName function to retrieve the name of a domain controller.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Wtsapi32.h

Library

Wtsapi32.lib

DLL

Wtsapi32.dll

Unicode and ANSI names

WTSQueryUserConfigW (Unicode) and WTSQueryUserConfigA (ANSI)

See also

WTSFreeMemory
WTSSetUserConfig
WTS_CONFIG_CLASS

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.