GetDefaultUserProfileDirectoryW, fonction (userenv.h)

  • Article

Récupère le chemin d’accès à la racine du profil de l’utilisateur par défaut.

Syntaxe

USERENVAPI BOOL GetDefaultUserProfileDirectoryW(
  [out, optional] LPWSTR  lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Paramètres

[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 par défaut. Définissez cette valeur sur NULL pour déterminer la taille requise de la mémoire tampon.

[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 suffisamment 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 GetDefaultUserProfileDirectory dans Windows XP :

C:\Documents and Settings\Default User

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

C:\Users\Default

Pour obtenir les chemins 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 GetDefaultUserProfileDirectory en tant qu’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. La combinaison 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

Condition requise Valeur
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

GetProfilesDirectory

GetUserProfileDirectory

Vue d’ensemble des profils utilisateur

Informations de référence sur les profils utilisateur