Função WTSSetUserConfigA (wtsapi32.h)

Artigo
11/20/2024

Modifica as informações de configuração para o usuário especificado no controlador de domínio especificado ou no servidor host de sessão da Área de Trabalho Remota (Host de Sessão de Área de Trabalho Remota).

Sintaxe

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

Parâmetros

[in] pServerName

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome de um controlador de domínio ou servidor host de sessão rd. Especifique WTS_CURRENT_SERVER_NAME para indicar o servidor host da sessão rd no qual seu aplicativo está em execução.

[in] pUserName

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do usuário cuja configuração está sendo definida.

[in] WTSConfigClass

Especifica o tipo de informação a ser definida para o usuário. Esse parâmetro pode ser um dos valores do tipo de enumeração WTS_CONFIG_CLASS. A documentação do WTS_CONFIG_CLASS descreve o formato dos dados especificados em ppBuffer para cada um dos tipos de informações.

[in] pBuffer

Ponteiro para os dados usados para modificar a configuração do usuário especificado.

[in] DataLength

Tamanho, em TCHARs, do buffer de do pBuffer.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será um valor diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Observações

As funções WTSQueryUserConfig e WTSSetUserConfig são passadas para um nome de servidor em vez de um identificador porque as informações da conta de usuário geralmente residem em um controlador de domínio. Para definir informações de configuração do usuário, use o controlador de domínio primário. Você pode chamar a função NetGetDCName para obter o nome do controlador de domínio primário. Para consultar informações de configuração do usuário, você pode usar a função NetGetAnyDCName para obter o nome de um controlador de domínio primário ou de backup.

Qualquer controlador de domínio pode definir ou consultar informações de configuração do usuário. Use a função DsGetDcName para recuperar o nome de um controlador de domínio.

Se o valor do parâmetro WTSConfigClass corresponder a um valor inteiro na enumeração WTS_CONFIG_CLASS, defina o valor a ser definido como um DWORD. Em seguida, converta o valor em um LPWSTR na chamada para WTSSetUserConfig, como no exemplo a seguir:

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

Nota

O cabeçalho wtsapi32.h define WTSSetUserConfig como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista
servidor com suporte mínimo	Windows Server 2008
da Plataforma de Destino	Windows
cabeçalho	wtsapi32.h
biblioteca	Wtsapi32.lib
de DLL	Wtsapi32.dll

Consulte também

WTSQueryUserConfig

WTS_CONFIG_CLASS

Compartilhar via