GetDiskFreeSpaceW-Funktion (fileapi.h)

  • Artikel

Ruft Informationen zum angegebenen Datenträger ab, einschließlich der Menge des freien Speicherplatzes auf dem Datenträger.

Syntax

BOOL GetDiskFreeSpaceW(
  [in]  LPCWSTR 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 es sich bei diesem Parameter um einen UNC-Namen handelt, 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 von Sektoren pro Cluster empfängt.

[out] lpBytesPerSector

Ein Zeiger auf eine Variable, die die Anzahl von Bytes pro Sektor empfängt.

[out] lpNumberOfFreeClusters

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

Wenn benutzerspezifische Datenträgerkontingente verwendet werden, kann dieser Wert kleiner als die Gesamtzahl der freien Cluster auf dem Datenträger sein.

[out] lpTotalNumberOfClusters

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

Wenn benutzerspezifische Datenträgerkontingente verwendet werden, kann dieser Wert kleiner als die Gesamtzahl der Cluster auf dem Datenträger sein.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Mit der GetDiskFreeSpaceEx-Funktion können Sie einen Teil der Arithmetik vermeiden, die für die GetDiskFreeSpace-Funktion erforderlich ist.

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

GetDiskFreeSpaceEx

GetDriveType