Función WTSQueryUserConfigA (wtsapi32.h)

Recupera información de configuración del usuario especificado en el controlador de dominio especificado o en el servidor host de sesión de Escritorio remoto (host de sesión de Escritorio remoto).

Sintaxis

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

Parámetros

[in] pServerName

Puntero a una cadena terminada en null que contiene el nombre de un controlador de dominio o un servidor host de sesión de Escritorio remoto. Especifique WTS_CURRENT_SERVER_NAME para indicar el servidor host de sesión de Escritorio remoto en el que se ejecuta la aplicación.

[in] pUserName

Puntero a una cadena terminada en NULL que contiene el nombre de usuario que se va a consultar. Para recuperar la configuración de usuario predeterminada para el servidor host de sesión de Escritorio remoto, establezca este parámetro en NULL.

Windows Server 2008 y Windows Vista: Establecer este parámetro en null devuelve un error.

[in] WTSConfigClass

Especifica el tipo de información que se va a recuperar. Este parámetro puede ser uno de los valores del tipo de enumeración WTS_CONFIG_CLASS. La documentación de WTS_CONFIG_CLASS describe el formato de los datos devueltos en ppBuffer para cada uno de los tipos de información.

[out] ppBuffer

Puntero a una variable que recibe un puntero a la información solicitada. El formato y el contenido de los datos dependen de la clase de información especificada en el parámetro WTSConfigClass. Para liberar el búfer devuelto, llame a la función WTSFreeMemory.

[out] pBytesReturned

Puntero a una variable que recibe el tamaño, en bytes, de los datos devueltos en ppBuffer.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si se produce un error en la función, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Observaciones

Las funciones de WTSQueryUserConfig y WTSSetUserConfig se pasan un nombre de servidor en lugar de un identificador porque la información de la cuenta de usuario suele residir en un controlador de dominio. Para establecer la información de configuración del usuario, use el controlador de dominio principal. Puede llamar a la función NetGetDCName para obtener el nombre del controlador de dominio principal. Para consultar la información de configuración del usuario, puede usar la función NetGetAnyDCName para obtener el nombre de un controlador de dominio principal o de copia de seguridad.

Cualquier controlador de dominio puede establecer o consultar la información de configuración del usuario. Use la función DsGetDcName para recuperar el nombre de un controlador de dominio.

Nota

El encabezado wtsapi32.h define WTSQueryUserConfig como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows Vista
servidor mínimo admitido	Windows Server 2008
de la plataforma de destino de	Windows
encabezado de	wtsapi32.h
biblioteca de	Wtsapi32.lib
DLL de	Wtsapi32.dll

Consulte también

WTSFreeMemory

WTSSetUserConfig

WTS_CONFIG_CLASS