Fungsi GetFileSize (fileapi.h)

Mengambil ukuran file yang ditentukan, dalam byte.

Disarankan agar Anda menggunakan GetFileSizeEx.

Sintaks

DWORD GetFileSize(
  [in]            HANDLE  hFile,
  [out, optional] LPDWORD lpFileSizeHigh
);

Parameter

[in] hFile

Handel ke file.

[out, optional] lpFileSizeHigh

Penunjuk ke variabel tempat kata ganda urutan tinggi dari ukuran file dikembalikan. Parameter ini bisa NULL jika aplikasi tidak memerlukan kata ganda urutan tinggi.

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah kata ganda urutan rendah dari ukuran file, dan, jika lpFileSizeHigh bukan NULL, fungsi menempatkan kata ganda urutan tinggi dari ukuran file ke dalam variabel yang ditujukkan oleh parameter tersebut.

Jika fungsi gagal dan lpFileSizeHigh adalah NULL, nilai yang dikembalikan adalah INVALID_FILE_SIZE. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError. Ketika lpFileSizeHigh adalah NULL, hasil yang dikembalikan untuk file besar ambigu, dan Anda tidak akan dapat menentukan ukuran file yang sebenarnya. Disarankan agar Anda menggunakan GetFileSizeEx sebagai gantinya.

Jika fungsi gagal dan lpFileSizeHigh bukan NULL, nilai yang dikembalikan INVALID_FILE_SIZE dan GetLastError akan mengembalikan nilai selain NO_ERROR.

Keterangan

Anda tidak dapat menggunakan fungsi GetFileSize dengan handel perangkat nonseeking seperti pipa atau perangkat komunikasi. Untuk menentukan jenis file untuk hFile, gunakan fungsi GetFileType .

Fungsi GetFileSize mengambil ukuran file yang tidak dikompresi. Gunakan fungsi GetCompressedFileSize untuk mendapatkan ukuran file yang dikompresi.

Perhatikan bahwa jika nilai yang dikembalikan INVALID_FILE_SIZE (0xffffffff), aplikasi harus memanggil GetLastError untuk menentukan apakah fungsi telah berhasil atau gagal. Alasan fungsi mungkin tampak gagal ketika belum adalah bahwa lpFileSizeHigh bisa non-NULL atau ukuran file dapat 0xffffffff. Dalam hal ini, GetLastError akan mengembalikan NO_ERROR (0) setelah berhasil. Karena perilaku ini, disarankan agar Anda menggunakan GetFileSizeEx sebagai gantinya.

Operasi yang Ditransaksikan: Jika ada transaksi yang terikat ke handel file, maka fungsi mengembalikan informasi untuk tampilan file yang terisolasi.

Di Windows 8 dan Windows Server 2012, fungsi ini didukung oleh teknologi berikut.

Teknologi	Didukung
Protokol Server Message Block (SMB) 3.0	Ya
SMB 3.0 Transparent Failover (TFO)	Ya
SMB 3.0 dengan Scale-out File Shares (SO)	Ya
Sistem File Volume Bersama Kluster (CsvFS)	Ya
Sistem File Tangguh (ReFS)	Ya

 

Contoh

Misalnya, lihat Membuat Tampilan Dalam File.

Persyaratan

Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	fileapi.h (sertakan Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Lihat juga

Fungsi Manajemen File

GetCompressedFileSize

GetFileSizeEx

GetFileType