GetCompressedFileSize.md

Home

Function name : GetCompressedFileSize

Group: File System - Library: kernel32

---

Retrieves the actual number of bytes of disk storage used to store a specified file. If the file is located on a volume that supports compression/sparse files, and the file is compressed, the value obtained is the compressed/sparse size of the specified file

---

Code examples:

Using GetCompressedFileSize (WinNT only)

Declaration:

DWORD GetCompressedFileSize(
  LPCTSTR lpFileName,     // file name
  LPDWORD lpFileSizeHigh  // high-order DWORD of file size
);  

---

FoxPro declaration:

DECLARE INTEGER GetCompressedFileSize IN kernel32;
	STRING    lpFileName,;
	INTEGER @ lpFileSizeHigh  

---

Parameters:

lpFileName [in] Pointer to a null-terminated string that specifies the name of the file.

lpFileSizeHigh [out] Pointer to a variable that receives the high-order DWORD of the compressed file size.

---

Return value:

If the function succeeds, the return value is the low-order DWORD of the actual number of bytes of disk storage used to store the specified file.

---

Comments:

Windows NT/2000/XP: Included in Windows NT 3.1 and later.
Windows 95/98/Me: Unsupported.

---