GetUserProfileDirectoryA, fonction (userenv.h)
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, retourné par l'LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessTokenou fonction OpenThreadToken. Le jeton doit avoir TOKEN_QUERY accès. Pour plus d’informations, consultez Droits d’accès pour Access-Token Objets.
[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
Si la mémoire tampon spécifiée par lpProfileDir n’est pas suffisamment grande ou lpProfileDir est 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 de retour
Type : BOOL
TRUE en cas de réussite ; sinon, FALSE. Pour obtenir des informations d’erreur étendues, 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
Note
L’en-tête userenv.h définit GetUserProfileDirectory 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 2000 Professionnel [applications de bureau uniquement] |
| serveur minimum pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| plateforme cible | Windows |
| d’en-tête | userenv.h |
| bibliothèque | Userenv.lib |
| DLL | Userenv.dll |
Voir aussi
GetDefaultUserProfileDirectory