GetDefaultUserProfileDirectoryA-Funktion (userenv.h)

Ruft den Pfad zum Stamm des Standardbenutzerprofils ab.

Syntax

USERENVAPI BOOL GetDefaultUserProfileDirectoryA(
  [out, optional] LPSTR   lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Parameter

[out, optional] lpProfileDir

Typ: LPTSTR

Ein Zeiger auf einen Puffer, der bei erfolgreicher Rückgabe dieser Funktion den Pfad zum Profilverzeichnis des Standardbenutzers empfängt. Legen Sie diesen Wert auf NULL fest, um die erforderliche Größe des Puffers zu bestimmen.

[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 GetDefaultUserProfileDirectory in Windows XP zurückgegeben wird:

C:\Documents and Settings\Default User

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

C:\Users\Default

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

Hinweis

Der userenv.h-Header definiert GetDefaultUserProfileDirectory 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

Anforderung	Wert
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

GetProfilesDirectory

GetUserProfileDirectory

Übersicht über Benutzerprofile

Referenz zu Benutzerprofilen