Función WTSSetUserConfigA (wtsapi32.h)
Modifica la 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 WTSSetUserConfigA(
[in] LPSTR pServerName,
[in] LPSTR pUserName,
[in] WTS_CONFIG_CLASS WTSConfigClass,
[in] LPSTR pBuffer,
[in] DWORD DataLength
);
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 del usuario cuya configuración se va a establecer.
[in] WTSConfigClass
Especifica el tipo de información que se va a establecer para el usuario. Este parámetro puede ser uno de los valores del tipo de enumeración WTS_CONFIG_CLASS . En la documentación de WTS_CONFIG_CLASS se describe el formato de los datos especificados en ppBuffer para cada uno de los tipos de información.
[in] pBuffer
Puntero a los datos usados para modificar la configuración del usuario especificado.
[in] DataLength
Tamaño, en TCHAR, del búfer de pBuffer .
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.
Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.
Comentarios
Las funciones 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.
Si el valor del parámetro WTSConfigClass corresponde a un valor entero en la enumeración WTS_CONFIG_CLASS , defina el valor que se va a establecer como DWORD. A continuación, convierta el valor en un LPWSTR en la llamada a WTSSetUserConfig, como en el ejemplo siguiente:
WTSSetUserConfig( strServer.GetBuffer(0),
m_strName.GetBuffer(0),
WTSUserConfigfAllowLogonTerminalServer,
(LPWSTR) &dwEnable,
sizeof(DWORD));
Nota
El encabezado wtsapi32.h define WTSSetUserConfig 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.
Requisitos
Requisito | Value |
---|---|
Cliente mínimo compatible | Windows Vista |
Servidor mínimo compatible | Windows Server 2008 |
Plataforma de destino | Windows |
Encabezado | wtsapi32.h |
Library | Wtsapi32.lib |
Archivo DLL | Wtsapi32.dll |