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

Статья
03/08/2023

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

Синтаксис

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

Размер буфера pBuffer в TCHAR.

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

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

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав 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
Целевая платформа	Windows
Header	wtsapi32.h
Библиотека	Wtsapi32.lib
DLL	Wtsapi32.dll

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

WTSQueryUserConfig

WTS_CONFIG_CLASS

Share via