GetUserProfileDirectoryW-Funktion (userenv.h)

Ruft den Pfad zum Stammverzeichnis des angegebenen Benutzerprofils ab.

Syntax

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

Parameter

[in] hToken

Typ: HANDLE

Ein Token für den Benutzer, das von der Funktion LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessToken oder OpenThreadToken zurückgegeben wird. Das Token muss über TOKEN_QUERY Zugriff verfügen. Weitere Informationen finden Sie unter Zugriffsrechte für Access-Token-Objekte.

[out, optional] lpProfileDir

Typ: LPTSTR

Ein Zeiger auf einen Puffer, der bei erfolgreicher Rückgabe dieser Funktion den Pfad zum Profilverzeichnis des angegebenen Benutzers empfängt.

[in, out] lpcchSize

Typ: LPDWORD

Gibt die Größe des lpProfileDir-Puffers in TCHARs an.

Wenn der durch lpProfileDir angegebene Puffer nicht groß genug ist oder lpProfileDirNULL ist, schlägt die Funktion fehl, und dieser Parameter empfängt die erforderliche Puffergröße, einschließlich des beendenden NULL-Zeichens.

Rückgabewert

Typ: BOOL

TRUE , wenn erfolgreich; andernfalls FALSE. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Im Folgenden finden Sie ein Beispiel für den Pfad, der von GetUserProfileDirectory in Windows XP zurückgegeben wird:

C:\Documents and Settings\Joe

Im Folgenden finden Sie ein Beispiel für den Pfad, der von GetUserProfileDirectory in Windows 7 zurückgegeben wird:

C:\Users\Joe

Verwenden Sie zum Abrufen der Pfade von Unterverzeichnissen dieses Verzeichnisses die Funktion SHGetFolderPath (Windows XP und früher) oder SHGetKnownFolderPath (Windows Vista).

Hinweis

Der Header userenv.h definiert GetUserProfileDirectory als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	userenv.h
Bibliothek	Userenv.lib
DLL	Userenv.dll

Weitere Informationen

GetAllUsersProfileDirectory

GetDefaultUserProfileDirectory

GetProfilesDirectory

Übersicht über Benutzerprofile

Referenz zu Benutzerprofilen