Fungsi GetDiskFreeSpaceA (fileapi.h)

Mengambil informasi tentang disk yang ditentukan, termasuk jumlah ruang kosong pada disk.

Sintaksis

BOOL GetDiskFreeSpaceA(
  [in]  LPCSTR  lpRootPathName,
  [out] LPDWORD lpSectorsPerCluster,
  [out] LPDWORD lpBytesPerSector,
  [out] LPDWORD lpNumberOfFreeClusters,
  [out] LPDWORD lpTotalNumberOfClusters
);

Parameter

[in] lpRootPathName

Direktori akar disk tempat informasi akan dikembalikan. 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\"). Selain itu, spesifikasi drive harus memiliki garis miring terbelakang (misalnya, "C:\"). Aplikasi panggilan harus memiliki hak akses FILE_LIST_DIRECTORY untuk direktori ini.

[out] lpSectorsPerCluster

Pointer ke variabel yang menerima jumlah sektor per kluster.

[out] lpBytesPerSector

Pointer ke variabel yang menerima jumlah byte per sektor.

[out] lpNumberOfFreeClusters

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

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

[out] lpTotalNumberOfClusters

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

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

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

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

Komentar

Fungsi GetDiskFreeSpaceEx memungkinkan Anda menghindari beberapa aritmatika yang diperlukan oleh fungsi GetDiskFreeSpace.

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

Nota

Header fileapi.h mendefinisikan GetDiskFreeSpace sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praproscesor 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

GetDiskFreeSpaceEx

GetDriveType