GetDiskFreeSpaceExA-Funktion (fileapi.h)
Ruft Informationen über die Menge des Speicherplatzes ab, der auf einem Datenträgervolume verfügbar ist, d. h. die Gesamtmenge des freien Speicherplatzes, die Gesamtmenge des freien Speicherplatzes, der für den Benutzer verfügbar ist, der dem aufrufenden Thread zugeordnet ist.
Syntax
BOOL GetDiskFreeSpaceExA(
[in, optional] LPCSTR lpDirectoryName,
[out, optional] PULARGE_INTEGER lpFreeBytesAvailableToCaller,
[out, optional] PULARGE_INTEGER lpTotalNumberOfBytes,
[out, optional] PULARGE_INTEGER lpTotalNumberOfFreeBytes
);
Parameter
[in, optional] lpDirectoryName
Ein Verzeichnis auf dem Datenträger.
Wenn dieser Parameter NULL-ist, verwendet die Funktion den Stamm des aktuellen Datenträgers.
Wenn dieser Parameter ein UNC-Name ist, muss er einen nachfolgenden umgekehrten Schrägstrich enthalten, z. B. "\\MyServer\MyShare\".
Dieser Parameter muss das Stammverzeichnis auf einem Datenträger nicht angeben. Die Funktion akzeptiert ein beliebiges Verzeichnis auf einem Datenträger.
Die aufrufende Anwendung muss über FILE_LIST_DIRECTORY Zugriffsrechte verfügen.
Verzeichnis.
[out, optional] lpFreeBytesAvailableToCaller
Ein Zeiger auf eine Variable, die die Gesamtanzahl der freien Bytes auf einem Datenträger empfängt, die dem Benutzer zur Verfügung stehen, der dem aufrufenden Thread zugeordnet ist.
Dieser Parameter kann NULL-sein.
Wenn Kontingente pro Benutzer verwendet werden, kann dieser Wert kleiner als die Gesamtanzahl der freien Bytes auf einem Datenträger sein.
[out, optional] lpTotalNumberOfBytes
Ein Zeiger auf eine Variable, die die Gesamtanzahl der Bytes auf einem Datenträger empfängt, die dem Benutzer zur Verfügung stehen, der dem aufrufenden Thread zugeordnet ist.
Dieser Parameter kann NULL-sein.
Wenn Kontingente pro Benutzer verwendet werden, kann dieser Wert kleiner als die Gesamtanzahl der Bytes auf einem Datenträger sein.
Verwenden Sie IOCTL_DISK_GET_LENGTH_INFO, um die Gesamtanzahl der Bytes auf einem Datenträger oder Volume zu ermitteln.
[out, optional] lpTotalNumberOfFreeBytes
Ein Zeiger auf eine Variable, die die Gesamtanzahl der freien Bytes auf einem Datenträger empfängt.
Dieser Parameter kann NULL-sein.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null (0). Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Die von dieser Funktion abgerufenen Werte sind vom Typ ULARGE_INTEGER. Diese Werte nicht auf 32 Bit abschneiden.
Die GetDiskFreeSpaceEx-funktion gibt null (0) für lpTotalNumberOfFreeBytes und lpFreeBytesAvailable für alle CD-Anforderungen zurück, es sei denn, der Datenträger ist eine ungeschriebene CD in einem CD-RW Laufwerk.
Verhalten symbolischer Verknüpfungen – Wenn der Pfad auf eine symbolische Verknüpfung verweist, wird der Vorgang für das Ziel ausgeführt.
Anmerkung
Der Fileapi.h-Header definiert GetDiskFreeSpaceEx 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 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 XP [Desktop-Apps | UWP-Apps] |
| mindestens unterstützte Server- | Windows Server 2003 [Desktop-Apps | UWP-Apps] |
| Zielplattform- | Fenster |
| Header- | fileapi.h (include Windows.h) |
| Library | Kernel32.lib |
| DLL- | Kernel32.dll |