GetAllUsersProfileDirectoryA-Funktion (userenv.h)

Ruft den Pfad zum Stammverzeichnis des Verzeichnisses ab, das Programmdaten enthält, die von allen Benutzern freigegeben werden.

Syntax

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

Parameter

[out, optional] lpProfileDir

Typ: LPTSTR

Ein Zeiger auf einen Puffer, der den Pfad empfängt, wenn diese Funktion erfolgreich zurückgibt. Legen Sie diesen Wert auf NULL fest, um die erforderliche Größe des Puffers zu bestimmen, einschließlich des beendenden NULL-Zeichens.

[in, out] lpcchSize

Typ: LPDWORD

Ein Zeiger auf die Größe des lpProfileDir-Puffers in TCHARs.

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

C:\Documents and Settings\All Users

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

C:\ProgramData

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 GetAllUsersProfileDirectory 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 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

GetDefaultUserProfileDirectory

GetProfilesDirectory

GetUserProfileDirectory

Übersicht über Benutzerprofile

Referenz zu Benutzerprofilen