GetUserProfileDirectoryA-Funktion (userenv.h)
Ruft den Pfad zum Stammverzeichnis des Profils des angegebenen Benutzers ab.
Syntax
USERENVAPI BOOL GetUserProfileDirectoryA(
[in] HANDLE hToken,
[out, optional] LPSTR lpProfileDir,
[in, out] LPDWORD lpcchSize
);
Parameter
[in] hToken
Typ: HANDLE
Ein Token für den Benutzer, der von der LogonUserzurückgegeben wird, CreateRestrictedToken, DuplicateToken, OpenProcessTokenoder OpenThreadToken Funktion. Das Token muss über TOKEN_QUERY Zugriff verfügen. Weitere Informationen finden Sie unter Access Rights for Access-Token Objects.
[out, optional] lpProfileDir
Typ: LPTSTR-
Ein Zeiger auf einen Puffer, der, wenn diese Funktion erfolgreich zurückgegeben wird, 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 lpProfileDir-NULL-ist, schlägt die Funktion fehl, und dieser Parameter empfängt die erforderliche Puffergröße, einschließlich des endierenden NULL-Zeichens.
Rückgabewert
Typ: BOOL-
TRUE bei erfolgreicher Ausführung; andernfalls FALSE. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Es folgt ein Beispiel für den Pfad, der von GetUserProfileDirectory in Windows XP zurückgegeben wird:
C:\Documents and Settings\Joe
Es folgt ein Beispiel für den Pfad, der von GetUserProfileDirectory in Windows 7 zurückgegeben wird:
C:\Users\Joe
Um die Pfade von Unterverzeichnissen dieses Verzeichnisses abzurufen, verwenden Sie die SHGetFolderPath- (Windows XP und früher) oder SHGetKnownFolderPath (Windows Vista)-Funktion.
Anmerkung
Der Header "userenv.h" definiert GetUserProfileDirectory als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, 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 |
|---|---|
| mindestens unterstützte Client- | Windows 2000 Professional [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | userenv.h |
| Library | Userenv.lib |
| DLL- | Userenv.dll |
Siehe auch
GetDefaultUserProfileDirectory
übersicht über Benutzerprofile