Fungsi FilterInstanceGetInformation (fltuser.h)

Artikel
03/09/2024

Fungsi FilterInstanceGetInformation mengembalikan berbagai jenis informasi tentang instans minifilter.

Sintaks

HRESULT FilterInstanceGetInformation(
  [in]  HFILTER_INSTANCE           hInstance,
  [in]  INSTANCE_INFORMATION_CLASS dwInformationClass,
  [out] LPVOID                     lpBuffer,
  [in]  DWORD                      dwBufferSize,
  [out] LPDWORD                    lpBytesReturned
);

Parameter

[in] hInstance

Menangani yang dikembalikan oleh panggilan sebelumnya ke FilterInstanceCreate.

[in] dwInformationClass

Jenis struktur informasi instans dikembalikan. Parameter ini harus berisi salah satu nilai berikut.

Nilai	Makna
InstanceBasicInformation	Mengembalikan struktur INSTANCE_BASIC_INFORMATION untuk instans.
InstanceFullInformation	Mengembalikan struktur INSTANCE_FULL_INFORMATION untuk instans.
InstancePartialInformation	Mengembalikan struktur INSTANCE_PARTIAL_INFORMATION untuk instans.
InstanceAggregateStandardInformation	Mengembalikan struktur INSTANCE_AGGREGATE_STANDARD_INFORMATION untuk instans. Bagian LegacyFilter dari struktur digunakan dimulai dengan Windows 8. 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 ditunjuk lpBuffer jika panggilan ke FilterInstanceGetInformation berhasil. Parameter ini diperlukan dan tidak boleh NULL.

Nilai kembali

FilterInstanceGetInformation mengembalikan S_OK jika berhasil. Jika tidak, ia mengembalikan nilai kesalahan HRESULT, seperti salah satu hal berikut ini:

Menampilkan kode	Deskripsi
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	Buffer yang ditujukkan 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 InstanceAggregateStandardInformation ditentukan untuk sistem operasi sebelum Windows Vista, FilterInstanceGetInformation mengembalikan nilai HRESULT ini.

Keterangan

Mengingat handel ke instans minifilter, rutinitas ini mengembalikan informasi tentang instans minifilter. Jenis informasi instans yang dikembalikan ditentukan oleh parameter dwInformationClass .

FilterInstanceGetInformation setara Win32 dengan FltGetInstanceInformation.