GetDiskFreeSpaceA-Funktion (fileapi.h)
Ruft Informationen zum angegebenen Datenträger ab, einschließlich der Menge an freiem Speicherplatz auf dem Datenträger.
Syntax
BOOL GetDiskFreeSpaceA(
[in] LPCSTR lpRootPathName,
[out] LPDWORD lpSectorsPerCluster,
[out] LPDWORD lpBytesPerSector,
[out] LPDWORD lpNumberOfFreeClusters,
[out] LPDWORD lpTotalNumberOfClusters
);
Parameter
[in] lpRootPathName
Das Stammverzeichnis des Datenträgers, für den Informationen zurückgegeben werden sollen. 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\"). Darüber hinaus muss eine Laufwerksspezifikation einen nachfolgenden umgekehrten Schrägstrich aufweisen (z. B. "C:\"). Die aufrufende Anwendung muss über FILE_LIST_DIRECTORY Zugriffsrechte für dieses Verzeichnis verfügen.
[out] lpSectorsPerCluster
Ein Zeiger auf eine Variable, die die Anzahl der Sektoren pro Cluster empfängt.
[out] lpBytesPerSector
Ein Zeiger auf eine Variable, die die Anzahl der Bytes pro Sektor empfängt.
[out] lpNumberOfFreeClusters
Ein Zeiger auf eine Variable, die die Gesamtanzahl der freien Cluster auf dem Datenträger empfängt, die dem Benutzer zur Verfügung stehen, der dem aufrufenden Thread zugeordnet ist.
Wenn Datenträgerkontingente pro Benutzer verwendet werden, kann dieser Wert kleiner als die Gesamtanzahl der freien Cluster auf dem Datenträger sein.
[out] lpTotalNumberOfClusters
Ein Zeiger auf eine Variable, die die Gesamtanzahl der Cluster auf dem Datenträger empfängt, die dem Benutzer zur Verfügung stehen, der dem aufrufenden Thread zugeordnet ist.
Wenn Datenträgerkontingente pro Benutzer verwendet werden, kann dieser Wert kleiner als die Gesamtanzahl der Cluster auf dem Datenträger sein.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Mit der GetDiskFreeSpaceEx--Funktion können Sie einige der arithmetischen Funktionen vermeiden, die von der GetDiskFreeSpace-Funktion benötigt werden.
Verhalten symbolischer Verknüpfungen – Wenn der Pfad auf eine symbolische Verknüpfung verweist, wird der Vorgang für das Ziel ausgeführt.
Anmerkung
Der Header fileapi.h definiert GetDiskFreeSpace 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 |