GetDiskFreeSpaceExA-Funktion (fileapi.h)

  • Artikel

Ruft Informationen über die Menge des verfügbaren Speicherplatzes auf einem Datenträgervolume ab, d. h. die Gesamtmenge des Speicherplatzes, die Gesamtmenge des freien Speicherplatzes und die Gesamtmenge des freien Speicherplatzes, der dem Benutzer zur Verfügung steht, 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 es sich bei diesem Parameter um einen UNC-Namen handelt, muss er einen nachfolgenden umgekehrten Schrägstrich enthalten, z. B. "\\MyServer\MyShare\".

Dieser Parameter muss nicht das Stammverzeichnis auf einem Datenträger angeben. Die Funktion akzeptiert jedes Verzeichnis auf einem Datenträger.

Die aufrufende Anwendung muss dafür über FILE_LIST_DIRECTORY Zugriffsrechte verfügen.
samples enthalten.

[out, optional] lpFreeBytesAvailableToCaller

Ein Zeiger auf eine Variable, die die Gesamtzahl der freien Bytes auf einem Datenträger empfängt, die für den Benutzer verfügbar sind, der dem aufrufenden Thread zugeordnet ist.

Dieser Parameter kann NULL sein.

Wenn Benutzerkontingente verwendet werden, kann dieser Wert kleiner als die Gesamtzahl der freien Bytes auf einem Datenträger sein.

[out, optional] lpTotalNumberOfBytes

Ein Zeiger auf eine Variable, die die Gesamtanzahl von Bytes auf einem Datenträger empfängt, die für den Benutzer verfügbar sind, der dem aufrufenden Thread zugeordnet ist.

Dieser Parameter kann NULL sein.

Wenn Benutzerkontingente 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 bestimmen.

[out, optional] lpTotalNumberOfFreeBytes

Ein Zeiger auf eine Variable, die die Gesamtzahl 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 0 (null). Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Die von dieser Funktion erhaltenen Werte sind vom Typ ULARGE_INTEGER. Kürzen Sie diese Werte nicht auf 32 Bit ab.

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.

Hinweis

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

   
Unterstützte Mindestversion (Client) Windows XP [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile fileapi.h (Einschließen von Windows.h)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Funktionen für die Datenträgerverwaltung

GetDiskFreeSpace

GetModuleHandle