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

Статья
11/20/2024

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

Синтаксис

BOOL WTSSetUserConfigA(
  [in] LPSTR            pServerName,
  [in] LPSTR            pUserName,
  [in] WTS_CONFIG_CLASS WTSConfigClass,
  [in] LPSTR            pBuffer,
  [in] DWORD            DataLength
);

Параметры

[in] pServerName

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

[in] pUserName

Указатель на строку, завершающую значение NULL, содержащую имя пользователя, конфигурация которого задана.

[in] WTSConfigClass

Указывает тип сведений, заданных для пользователя. Этот параметр может быть одним из значений из типа перечисления WTS_CONFIG_CLASS. Документация по WTS_CONFIG_CLASS описывает формат данных, указанных в ppBuffer для каждого типа информации.

[in] pBuffer

Указатель на данные, используемые для изменения конфигурации указанного пользователя.

[in] DataLength

РазмерTCHARs буфера .

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение является ненулевое значение.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Функции WTSQueryUserConfig и функции WTSSetUserConfig передают имя сервера вместо дескриптора, так как сведения об учетной записи пользователя часто находятся на контроллере домена. Чтобы задать сведения о конфигурации пользователя, используйте основной контроллер домена. Можно вызвать функцию NetGetDCName, чтобы получить имя основного контроллера домена. Для запроса сведений о конфигурации пользователя можно использовать функцию NetGetAnyDCName для получения имени основного или резервного контроллера домена.

Любой контроллер домена может задавать или запрашивать сведения о конфигурации пользователя. Используйте функцию DsGetDcName для получения имени контроллера домена.

Если значение параметра WTSConfigClass соответствует целочисленным значением перечисления WTS_CONFIG_CLASS, определите значение, которое необходимо задать как DWORD. Затем приведение значения к LPWSTR в вызове WTSSetUserConfig, как показано в следующем примере:

WTSSetUserConfig( strServer.GetBuffer(0), 
                  m_strName.GetBuffer(0), 
                  WTSUserConfigfAllowLogonTerminalServer, 
                  (LPWSTR) &dwEnable, 
                  sizeof(DWORD));

Заметка

Заголовок wtsapi32.h определяет WTSSetUserConfig как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows Vista
минимальный поддерживаемый сервер	Windows Server 2008
целевая платформа	Виндоус
заголовка	wtsapi32.h
библиотеки	Wtsapi32.lib
DLL	Wtsapi32.dll

См. также

WTSQueryUserConfig

WTS_CONFIG_CLASS

Поделиться через