WTSSetUserConfigA, fonction (wtsapi32.h)

Article
11/20/2024

Modifie les informations de configuration de l’utilisateur spécifié sur le contrôleur de domaine spécifié ou sur le serveur hôte de session Bureau à distance (hôte de session Bureau à distance).

Syntaxe

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

Paramètres

[in] pServerName

Pointeur vers une chaîne terminée par null contenant le nom d’un contrôleur de domaine ou d’un serveur hôte de session Bureau à distance. Spécifiez WTS_CURRENT_SERVER_NAME pour indiquer le serveur hôte de session Bureau à distance sur lequel votre application s’exécute.

[in] pUserName

Pointeur vers une chaîne terminée par null contenant le nom de l’utilisateur dont la configuration est définie.

[in] WTSConfigClass

Spécifie le type d’informations à définir pour l’utilisateur. Ce paramètre peut être l’une des valeurs du type d’énumération WTS_CONFIG_CLASS. La documentation relative à WTS_CONFIG_CLASS décrit le format des données spécifiées dans ppBuffer pour chacun des types d’informations.

[in] pBuffer

Pointeur vers les données utilisées pour modifier la configuration de l’utilisateur spécifié.

[in] DataLength

Taille, dans mémoire tampon TCHAR, du tampon pBuffer .

Valeur de retour

Si la fonction réussit, la valeur de retour est une valeur différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Remarques

Les fonctions WTSQueryUserConfig et WTSSetUserConfig sont passées un nom de serveur au lieu d’un handle, car les informations de compte d’utilisateur résident souvent sur un contrôleur de domaine. Pour définir des informations de configuration utilisateur, utilisez le contrôleur de domaine principal. Vous pouvez appeler la fonction NetGetDCName pour obtenir le nom du contrôleur de domaine principal. Pour interroger les informations de configuration utilisateur, vous pouvez utiliser la fonction NetGetAnyDCName pour obtenir le nom d’un contrôleur de domaine principal ou de sauvegarde.

N’importe quel contrôleur de domaine peut définir ou interroger des informations de configuration utilisateur. Utilisez la fonction DsGetDcName pour récupérer le nom d’un contrôleur de domaine.

Si la valeur du paramètre WTSConfigClass correspond à une valeur entière dans l’énumération WTS_CONFIG_CLASS, définissez la valeur à définir comme DWORD. Effectuez ensuite un cast de la valeur en LPWSTR dans l’appel à WTSSetUserConfig, comme dans l’exemple suivant :

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

Note

L’en-tête wtsapi32.h définit WTSSetUserConfig comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows Vista
serveur minimum pris en charge	Windows Server 2008
plateforme cible	Windows
d’en-tête	wtsapi32.h
bibliothèque	Wtsapi32.lib
DLL	Wtsapi32.dll

Voir aussi

WTSQueryUserConfig

WTS_CONFIG_CLASS

Partager via