Fungsi GetFileInformationByHandle (fileapi.h)

  • Artikel

Mengambil informasi file untuk file yang ditentukan.

Untuk versi yang lebih canggih dari fungsi ini, lihat GetFileInformationByHandleEx.

Untuk mengatur informasi file menggunakan handel file, lihat SetFileInformationByHandle.

Sintaks

BOOL GetFileInformationByHandle(
  [in]  HANDLE                       hFile,
  [out] LPBY_HANDLE_FILE_INFORMATION lpFileInformation
);

Parameter

[in] hFile

Handel ke file yang berisi informasi yang akan diambil.

Handel ini seharusnya bukan handel pipa.

[out] lpFileInformation

Penunjuk ke struktur BY_HANDLE_FILE_INFORMATION yang menerima informasi file.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol dan data informasi file terkandung dalam buffer yang ditujukkan oleh parameter lpFileInformation .

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

Keterangan

Bergantung pada fitur jaringan yang mendasar dari sistem operasi dan jenis server yang terhubung ke, fungsi GetFileInformationByHandle mungkin gagal, mengembalikan informasi parsial, atau informasi lengkap untuk file yang diberikan.

Anda dapat membandingkan anggota VolumeSerialNumber dan FileIndex yang dikembalikan dalam struktur BY_HANDLE_FILE_INFORMATION untuk menentukan apakah dua jalur dipetakan ke target yang sama; misalnya, Anda dapat membandingkan dua jalur file dan menentukan apakah mereka memetakan ke direktori yang sama.

IIn 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 Berbagi File Peluasan Skala (SO) Ya
Sistem File Volume Bersama Kluster (CsvFS) Ya
Sistem File Tangguh (ReFS) Ya
 

Operasi Yang Ditransaksikan

Jika ada transaksi yang terikat ke utas pada saat panggilan, maka fungsi mengembalikan ukuran file terkompresi dari tampilan file yang terisolasi. Untuk informasi selengkapnya, lihat Tentang Transactional NTFS.

Persyaratan

Persyaratan Nilai
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

GetFileInformationByHandleEx

SetFileInformationByHandle