IFilter::Metode GetChunk (filter.h)

Catatan

Layanan Pengindeksan tidak lagi didukung pada Windows XP dan tidak tersedia untuk digunakan pada Windows 8. Sebagai gantinya, gunakan Windows Search untuk pencarian sisi klien dan Microsoft Search Server Express untuk pencarian sisi server.

Memposisikan filter di awal gugus berikutnya, atau pada gugus pertama jika ini adalah panggilan pertama ke metode GetChunk , dan mengembalikan deskripsi gugus saat ini.

Sintaks

SCODE GetChunk(
  [out] STAT_CHUNK *pStat
);

Parameter

[out] pStat

Penunjuk ke struktur STAT_CHUNK yang berisi deskripsi potongan saat ini.

Menampilkan nilai

Metode ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode Deskripsi
S_OK
Operasi berhasil diselesaikan.
FILTER_E_END_OF_CHUNKS
Gugus sebelumnya adalah gugus terakhir.
FILTER_E_EMBEDDING_UNAVAILABLE
Gugus berikutnya adalah penyematan dan tidak ada filter konten yang tersedia.
FILTER_E_LINK_UNAVAILABLE
Gugus berikutnya adalah tautan dan tidak ada filter konten yang tersedia.
FILTER_E_PASSWORD
Kata sandi atau kegagalan akses terkait keamanan lainnya.
FILTER_E_ACCESS
Kegagalan akses umum.

Keterangan

Jika pStat pengembalian menunjuk ke struktur STAT_CHUNK dengan anggota breakType yang sama dengan CHUNK_NO_BREAK, hanya anggota idChunk yang akan diperbarui dengan nilai pengidentifikasi gugus (ID) baru. Anggota lain dari struktur STAT_CHUNK tetap tidak berubah.

Properti jenis nilai internal (gugus dengan nilai enumerasi CHUNKSTATE CHUNK_VALUE) tidak dapat digabungkan menggunakan CHUNK_NO_BREAK. Satu kata tidak dapat menjangkau lebih dari dua gugus yang dilem.

Nol ID gugus tidak valid.

Sebelum metode GetChunk dipanggil untuk pertama kalinya, tidak ada gugus saat ini. Setelah kesalahan mengembalikan kode apa pun selain FILTER_E_END_OF_CHUNKS panggilan berikutnya ke metode GetChunk tetap mengambil gugus berikutnya setelah yang tidak tersedia.

Catatan untuk Penelepon

Ketika metode GetChunk selesai, gugus yang dijelaskan dalam *pStat adalah gugus saat ini. Deskriptor gugus dimiliki oleh rutinitas memanggil metode GetChunk , tetapi penunjuk nama properti, yang dapat diatur dalam spesifikasi properti, dimiliki oleh metode GetChunk dan tidak boleh dibebaskan.

Catatan untuk Pelaksana

Jika panggilan ke metode GetChunk dari filter konten objek yang ditautkan atau disematkan mengembalikan FILTER_E_END_OF_CHUNKS, implementasi harus mengembalikan potongan berikutnya dari objek penautan atau penyematan. Misalnya, jika dokumen memiliki dua objek yang disematkan dan yang pertama telah mengembalikan FILTER_E_END_OF_CHUNKS, filter konten luar harus memanggil metode GetChunk dari filter konten untuk objek yang disematkan.

Sebelum mengembalikan hasil panggilan ke metode GetChunk pada objek yang disematkan atau ditautkan, periksa untuk memastikan bahwa ID gugus unik. Jika tidak, pelaksana harus menjumlahkan ulang gugus dan menyimpan pemetaan ID gugus baru.

Persyaratan

   
Klien minimum yang didukung Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung Windows 2000 Server [hanya aplikasi desktop]
Target Platform Windows
Header filter.h

Lihat juga

IFilter

STAT_CHUNK