Fungsi FilterVolumeFindFirst (fltuser.h)

Artikel
08/23/2023

Fungsi FilterVolumeFindFirst mengembalikan informasi tentang volume.

Sintaks

HRESULT FilterVolumeFindFirst(
  [in]  FILTER_VOLUME_INFORMATION_CLASS dwInformationClass,
  [out] LPVOID                          lpBuffer,
  [in]  DWORD                           dwBufferSize,
  [out] LPDWORD                         lpBytesReturned,
  [out] PHANDLE                         lpVolumeFind
);

Parameter

[in] dwInformationClass

Jenis informasi yang diminta. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
FilterVolumeBasicInformation	Buffer yang ditujukkan oleh parameter lpBuffer menerima struktur FILTER_VOLUME_BASIC_INFORMATION untuk volume.
FilterVolumeStandardInformation	Buffer yang ditujukkan oleh parameter lpBuffer menerima struktur FILTER_VOLUME_STANDARD_INFORMATION untuk volume. Struktur ini tersedia dimulai dengan Windows Vista.

[out] lpBuffer

Arahkan ke buffer yang dialokasikan penelepon yang menerima informasi yang diminta. Jenis informasi yang dikembalikan dalam buffer ditentukan oleh parameter dwInformationClass .

[in] dwBufferSize

Ukuran, dalam byte, dari buffer yang dirujuk parameter lpBuffer . Pemanggil harus mengatur parameter ini sesuai dengan dwInformationClass yang diberikan.

[out] lpBytesReturned

Penunjuk ke variabel yang dialokasikan penelepon yang menerima jumlah byte yang dikembalikan dalam buffer yang dituju lpBuffer jika panggilan ke FilterVolumeFindFirst berhasil. Parameter ini diperlukan dan tidak boleh NULL.

[out] lpVolumeFind

Penunjuk ke variabel yang dialokasikan penelepon yang menerima handel pencarian untuk minifilter jika panggilan ke FilterVolumeFindFirst berhasil; jika tidak, ia menerima INVALID_HANDLE_VALUE. Handel pencarian ini dapat digunakan dalam panggilan berikutnya ke FilterVolumeFindNext dan FilterVolumeFindClose.

Nilai kembali

FilterVolumeFindFirst mengembalikan S_OK jika berhasil mengembalikan informasi tentang volume. Jika tidak, ia mengembalikan nilai kesalahan HRESULT, seperti salah satu hal berikut ini:

Menampilkan kode	Deskripsi
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	Buffer yang diacu oleh lpBuffer tidak cukup besar untuk berisi informasi yang diminta. Ketika nilai ini dikembalikan, lpBytesReturned akan berisi ukuran, dalam byte, dari buffer yang diperlukan untuk struktur dwInformationClass yang diberikan.
HRESULT_FROM_WIN32(ERROR_INVALID_PARAMETER)	Nilai yang tidak valid ditentukan untuk parameter dwInformationClass . Misalnya, jika FilterVolumeStandardInformation ditentukan untuk sistem operasi sebelum Windows Vista, FilterVolumeFindFirst mengembalikan nilai HRESULT ini.
HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS)	Volume tidak ditemukan dalam daftar volume yang diketahui oleh manajer filter.

Keterangan

Fungsi FilterVolumeFindFirst ini digunakan untuk mulai memindai volume yang diketahui oleh manajer filter.

FilterVolumeFindFirst membuka handel pencarian dan mengembalikan informasi tentang volume pertama yang ditemukan dalam daftar volume yang diketahui oleh manajer filter. Setelah handel pencarian dibuat, gunakan fungsi FilterVolumeFindNext untuk mencari volume lain dalam daftar manajer filter. Ketika handel pencarian tidak lagi diperlukan, tutup dengan memanggil FilterVolumeFindClose.

Perhatikan bahwa ketika menggunakan FilterVolumeFindFirst dan FilterVolumeFindNext untuk menghitung daftar volume yang diketahui oleh manajer filter, dimungkinkan untuk dua volume atau lebih dalam daftar untuk memiliki nama yang sama. Untuk informasi selengkapnya, lihat Memahami Enumerasi Volume dengan Nama Volume Duplikat.