Функция WTSQueryUserConfigA (wtsapi32.h)

Извлекает сведения о конфигурации для указанного пользователя на указанном контроллере домена или сервере узла сеансов удаленных рабочих столов (узел сеансов удаленных рабочих столов).

Синтаксис

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

Параметры

[in] pServerName

Указатель на строку, завершающуюся значением NULL, содержащую имя контроллера домена или сервера узла сеансов удаленных рабочих стола. Укажите WTS_CURRENT_SERVER_NAME , чтобы указать сервер узла сеансов удаленных рабочих стола, на котором выполняется приложение.

[in] pUserName

Указатель на строку с пустым завершением, содержащую имя пользователя для запроса. Чтобы получить пользовательские параметры по умолчанию для сервера узла сеансов удаленных рабочих стола, задайте для этого параметра значение 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 , чтобы получить имя контроллера домена.

Требования

См. также раздел

WTSFreeMemory

WTSSetUserConfig

WTS_CONFIG_CLASS