GetUserProfileDirectoryA, fonction (userenv.h)

  • Article

Récupère le chemin d’accès au répertoire racine du profil de l’utilisateur spécifié.

Syntaxe

USERENVAPI BOOL GetUserProfileDirectoryA(
  [in]            HANDLE  hToken,
  [out, optional] LPSTR   lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Paramètres

[in] hToken

Type : HANDLE

Jeton pour l’utilisateur, qui est retourné par la fonction LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessToken ou OpenThreadToken . Le jeton doit avoir un accès TOKEN_QUERY. Pour plus d’informations, consultez Droits d’accès pour les objets Access-Token.

[out, optional] lpProfileDir

Type : LPTSTR

Pointeur vers une mémoire tampon qui, lorsque cette fonction retourne correctement, reçoit le chemin d’accès au répertoire de profil de l’utilisateur spécifié.

[in, out] lpcchSize

Type : LPDWORD

Spécifie la taille de la mémoire tampon lpProfileDir , en TCHAR.

Si la mémoire tampon spécifiée par lpProfileDir n’est pas assez grande ou si lpProfileDir a la valeur NULL, la fonction échoue et ce paramètre reçoit la taille de mémoire tampon nécessaire, y compris le caractère null de fin.

Valeur retournée

Type : BOOL

TRUE en cas de réussite ; sinon, FALSE. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Voici un exemple de chemin d’accès retourné par GetUserProfileDirectory dans Windows XP :

C:\Documents and Settings\Joe

Voici un exemple de chemin d’accès retourné par GetUserProfileDirectory dans Windows 7 :

C:\Users\Joe

Pour obtenir les chemins d’accès des sous-répertoires de ce répertoire, utilisez la fonction SHGetFolderPath (Windows XP et versions antérieures) ou SHGetKnownFolderPath (Windows Vista).

Notes

L’en-tête userenv.h définit GetUserProfileDirectory 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.

Configuration requise

   
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête userenv.h
Bibliothèque Userenv.lib
DLL Userenv.dll

Voir aussi

GetAllUsersProfileDirectory

GetDefaultUserProfileDirectory

GetProfilesDirectory

Vue d’ensemble des profils utilisateur

Informations de référence sur les profils utilisateur