GetCompressedFileSizeA-Funktion (fileapi.h)

Artikel
11/20/2024

Ruft die tatsächliche Anzahl der Bytes des Datenträgerspeichers ab, der zum Speichern einer angegebenen Datei verwendet wird. Wenn sich die Datei auf einem Volume befindet, das komprimiert und die Datei komprimiert wird, ist der abgerufene Wert die komprimierte Größe der angegebenen Datei. Wenn sich die Datei auf einem Volume befindet, das sparse Dateien unterstützt und die Datei eine sparse Datei ist, ist der abgerufene Wert die geringe Größe der angegebenen Datei.

Verwenden Sie die GetCompressedFileSizeTransacted--Funktion, um diesen Vorgang als transacted-Vorgang auszuführen.

Syntax

DWORD GetCompressedFileSizeA(
  [in]            LPCSTR  lpFileName,
  [out, optional] LPDWORD lpFileSizeHigh
);

Parameter

[in] lpFileName

Der Name der Datei.

Geben Sie nicht den Namen einer Datei auf einem nicht eingesehten Gerät an, z. B. eine Pipe oder ein Kommunikationsgerät, da die Dateigröße keine Bedeutung hat.

Dieser Parameter kann den Pfad enthalten.

Standardmäßig ist der Name auf MAX_PATH Zeichen beschränkt. Um diesen Grenzwert auf 32.767 breite Zeichen zu erweitern, stellen Sie "\\?\" dem Pfad voran. Weitere Informationen finden Sie unter Namensdateien, Pfade und Namespaces.

Trinkgeld

Ab Windows 10, Version 1607, können Sie sich anmelden, um die MAX_PATH Einschränkung zu entfernen, ohne "\\?\". Weitere Informationen finden Sie im Abschnitt "Maximale Pfadlängenbeschränkung" Benennungsdateien, Pfade und Namespaces.

[out, optional] lpFileSizeHigh

Die hohe Reihenfolge DWORD- der komprimierten Dateigröße. Der Rückgabewert der Funktion ist die niedrige Reihenfolge DWORD- der komprimierten Dateigröße.

Dieser Parameter kann NULL- werden, wenn die hohe Reihenfolge DWORD- der komprimierten Dateigröße nicht erforderlich ist. Dateien mit weniger als 4 Gigabyte Größe benötigen nicht die hohe Reihenfolge DWORD-.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die niedrige Reihenfolge DWORD- der tatsächlichen Anzahl von Bytes des Datenträgerspeichers, der zum Speichern der angegebenen Datei verwendet wird, und wenn lpFileSizeHigh nichtNULL-ist, platziert die Funktion die hohe Reihenfolge DWORD- dieses tatsächlichen Werts in die DWORD-, auf die dieser Parameter verweist. Dies ist die komprimierte Dateigröße für komprimierte Dateien, die tatsächliche Dateigröße für nicht komprimierte Dateien.

Wenn die Funktion fehlschlägt und lpFileSizeHighNULL-ist, wird der Rückgabewert INVALID_FILE_SIZE. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Wenn der Rückgabewert INVALID_FILE_SIZE ist und lpFileSizeHigh nichtNULL-ist, muss eine Anwendung GetLastError- aufrufen, um zu bestimmen, ob die Funktion erfolgreich war (Wert ist NO_ERROR) oder fehlgeschlagen (Wert ist nicht NO_ERROR).

Bemerkungen

Eine Anwendung kann bestimmen, ob ein Volume komprimiert wird, indem GetVolumeInformationaufgerufen wird, und dann den Status des FS_VOL_IS_COMPRESSED Flags im DWORD--Wert überprüft wird, auf den der lpFileSystemFlags Parameter dieser Funktion verweist.

Wenn sich die Datei nicht auf einem Volume befindet, das Komprimierungs- oder Sparsedateien unterstützt, oder wenn die Datei nicht komprimiert oder eine sparse Datei ist, ist der abgerufene Wert die tatsächliche Dateigröße, identisch mit dem Wert, der von einem Aufruf von GetFileSizezurückgegeben wird.

Verhalten für symbolische Verknüpfungen – Wenn der Pfad auf eine symbolische Verknüpfung zeigt, gibt die Funktion die Dateigröße des Ziels zurück.

In Windows 8 und Windows Server 2012 wird diese Funktion von den folgenden Technologien unterstützt.

Technologie	Abgestützt
Server Message Block (SMB) 3.0-Protokoll	Ja
SMB 3.0 Transparent Failover (TFO)	Ja
SMB 3.0 mit Skalierungsdateifreigaben (SO)	Ja
Freigegebenes Clustervolumedateisystem (CsvFS)	Ja
Resilient File System (ReFS)	Ja

Anmerkung

Der Header fileapi.h definiert GetCompressedFileSize 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 [nur Desktop-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Zielplattform-	Fenster
Header-	fileapi.h (include Windows.h, WinBase.h, Fileapi.h, Windows.h, WinBase.h, Fileapi.h)
Library	Kernel32.lib
DLL-	Kernel32.dll