Fungsi GetDiskFreeSpaceExA (fileapi.h)

Mengambil informasi tentang jumlah ruang yang tersedia pada volume disk, yang merupakan jumlah total ruang, jumlah total ruang kosong, dan jumlah total ruang kosong yang tersedia untuk pengguna yang terkait dengan utas panggilan.

Sintaksis

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

Direktori pada disk.

Jika parameter ini NULL, fungsi menggunakan akar disk saat ini.

Jika parameter ini adalah nama UNC, parameter harus menyertakan garis miring terbelakang, misalnya, "\\MyServer\MyShare\".

Parameter ini tidak harus menentukan direktori akar pada disk. Fungsi menerima direktori apa pun pada disk.

Aplikasi panggilan harus memiliki hak akses FILE_LIST_DIRECTORY untuk ini
direktori.

[out, optional] lpFreeBytesAvailableToCaller

Pointer ke variabel yang menerima jumlah total byte gratis pada disk yang tersedia untuk pengguna yang terkait dengan utas panggilan.

Parameter ini dapat null.

Jika kuota per pengguna digunakan, nilai ini mungkin kurang dari jumlah total byte gratis pada disk.

[out, optional] lpTotalNumberOfBytes

Penunjuk ke variabel yang menerima jumlah total byte pada disk yang tersedia untuk pengguna yang terkait dengan utas panggilan.

Parameter ini dapat null.

Jika kuota per pengguna digunakan, nilai ini mungkin kurang dari jumlah total byte pada disk.

Untuk menentukan jumlah total byte pada disk atau volume, gunakan IOCTL_DISK_GET_LENGTH_INFO.

[out, optional] lpTotalNumberOfFreeBytes

Penunjuk ke variabel yang menerima jumlah total byte gratis pada disk.

Parameter ini dapat null.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol (0). Untuk mendapatkan informasi kesalahan yang diperluas, panggil GetLastError.

Komentar

Nilai yang diperoleh oleh fungsi ini adalah jenis ULARGE_INTEGER. Jangan memotong nilai-nilai ini menjadi 32 bit.

Fungsi GetDiskFreeSpaceEx mengembalikan nol (0) untuk lpTotalNumberOfFreeBytes dan lpFreeBytesAvailable untuk semua permintaan CD kecuali disk adalah CD yang tidak ditulis dalam drive CD-RW.

Perilaku tautan simbolis—Jika jalur menunjuk ke tautan simbolis, operasi dilakukan pada target.

Nota

Header fileapi.h mendefinisikan GetDiskFreeSpaceEx sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosektor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows XP [aplikasi desktop | Aplikasi UWP]
server minimum yang didukung	Windows Server 2003 [aplikasi desktop | Aplikasi UWP]
Platform Target	Windows
Header	fileapi.h (termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Lihat juga

Fungsi Manajemen Disk

GetDiskFreeSpace

GetModuleHandle