Função WTSQueryUserConfigA (wtsapi32.h)

Recupera informações de configuração para o usuário especificado no controlador de domínio especificado ou servidor host de sessão de área de trabalho remota (host de sessão rd).

Sintaxe

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

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 um servidor host de sessão de área de trabalho remota. 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 de usuário a ser consultado. Para recuperar as configurações de usuário padrão para o servidor Host de Sessão de Área de Trabalho Remota, defina esse parâmetro como NULL.

Windows Server 2008 e Windows Vista: Definir esse parâmetro como NULL retorna um erro.

[in] WTSConfigClass

Especifica o tipo de informação a ser recuperado. 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 retornados no ppBuffer para cada um dos tipos de informações.

[out] ppBuffer

Ponteiro para uma variável que recebe um ponteiro para as informações solicitadas. O formato e o conteúdo dos dados dependem da classe de informações especificada no parâmetro WTSConfigClass . Para liberar o buffer retornado, chame a função WTSFreeMemory .

[out] pBytesReturned

Ponteiro para uma variável que recebe o tamanho, em bytes, dos dados retornados no ppBuffer.

Valor retornado

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.

Comentários

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.

Observação

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

Requisitos

Cliente mínimo com suporte	Windows Vista
Servidor mínimo com suporte	Windows Server 2008
Plataforma de Destino	Windows
Cabeçalho	wtsapi32.h
Biblioteca	Wtsapi32.lib
DLL	Wtsapi32.dll

Confira também

WTSFreeMemory

WTSSetUserConfig

WTS_CONFIG_CLASS