Fonction WTSQueryUserConfigA (wtsapi32.h)

Article
08/28/2023

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

Syntaxe

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

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 d’utilisateur à interroger. Pour récupérer les paramètres utilisateur par défaut du serveur hôte de session Bureau à distance, définissez ce paramètre sur NULL.

Windows Server 2008 et Windows Vista : La définition de ce paramètre sur NULL renvoie une erreur.

[in] WTSConfigClass

Spécifie le type d’informations à récupérer. Ce paramètre peut être l’une des valeurs du type d’énumération WTS_CONFIG_CLASS . La documentation de WTS_CONFIG_CLASS décrit le format des données retournées dans ppBuffer pour chacun des types d’informations.

[out] ppBuffer

Pointeur vers une variable qui reçoit un pointeur vers les informations demandées. Le format et le contenu des données dépendent de la classe d’informations spécifiée dans le paramètre WTSConfigClass . Pour libérer la mémoire tampon retournée, appelez la fonction WTSFreeMemory .

[out] pBytesReturned

Pointeur vers une variable qui reçoit la taille, en octets, des données retournées dans ppBuffer.

Valeur retournée

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étaillées sur l’erreur, appelez GetLastError.

Remarques

Les fonctions WTSQueryUserConfig et WTSSetUserConfig reçoivent un nom de serveur plutôt qu’un handle, car les informations de compte d’utilisateur résident souvent sur un contrôleur de domaine. Pour définir les 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.

Notes

L’en-tête wtsapi32.h définit WTSQueryUserConfig comme un 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.

Spécifications


Client minimal pris en charge	Windows Vista
Serveur minimal pris en charge	Windows Server 2008
Plateforme cible	Windows
En-tête	wtsapi32.h
Bibliothèque	Wtsapi32.lib
DLL	Wtsapi32.dll

Voir aussi

WTSFreeMemory

WTSSetUserConfig

WTS_CONFIG_CLASS

Partager via