Функция 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, содержащую имя пользователя для запроса. Чтобы получить параметры пользователя по умолчанию для сервера узла сеансов удаленных рабочих стола, задайте для этого параметра значение значение 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 как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.
Требования
| Требование | Ценность |
|---|---|
| минимальные поддерживаемые клиентские | Windows Vista |
| минимальный поддерживаемый сервер | Windows Server 2008 |
| целевая платформа | Виндоус |
| заголовка | wtsapi32.h |
| библиотеки |
Wtsapi32.lib |
| DLL | Wtsapi32.dll |