Bagikan melalui


Metode IFilter::GetText (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.

Mengambil teks (properti jenis teks) dari gugus saat ini, yang harus memiliki nilai enumerasi CHUNKSTATE CHUNK_TEXT.

Sintaks

SCODE GetText(
  [in, out] ULONG *pcwcBuffer,
  [out]     WCHAR *awcBuffer
);

Parameter

[in, out] pcwcBuffer

Pada entri, ukuran array awcBuffer dalam karakter wide/Unicode. Saat keluar, jumlah karakter Unicode yang ditulis ke awcBuffer.

[out] awcBuffer

Teks yang diambil dari gugus saat ini. Jangan hentikan buffer dengan karakter. Gunakan string yang dihentikan null. String yang dihentikan null tidak boleh melebihi ukuran buffer tujuan.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode Deskripsi
S_OK
Operasi berhasil diselesaikan.
FILTER_E_NO_TEXT
Anggota bendera struktur STAT_CHUNK untuk gugus saat ini tidak memiliki nilai CHUNK_TEXT.
FILTER_E_NO_MORE_TEXT
Semua teks dalam gugus saat ini telah dikembalikan. Panggilan tambahan ke metode GetText harus mengembalikan kesalahan ini sampai metode IFilter::GetChunk berhasil dipanggil.
FILTER_S_LAST_TEXT
Sebagai pengoptimalan, panggilan terakhir yang mengembalikan teks dapat mengembalikan FILTER_S_LAST_TEXT, menunjukkan bahwa panggilan berikutnya ke metode GetText akan mengembalikan FILTER_E_NO_MORE_TEXT. Pengoptimalan ini dapat menghemat waktu dengan menghilangkan panggilan yang tidak perlu ke GetText.

Keterangan

Jika gugus saat ini terlalu besar untuk array awcBuffer , lebih dari satu panggilan ke metode GetText dapat diperlukan untuk mengambil semua teks dalam gugus saat ini. Setiap panggilan ke metode GetText mengambil teks yang segera mengikuti teks dari panggilan terakhir ke metode GetText . Karakter terakhir dari satu panggilan dapat berada di tengah kata, dan karakter pertama dalam panggilan berikutnya akan melanjutkan kata itu. Mesin pencari harus menangani situasi ini.

Persyaratan

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

CHUNKSTATE

IFilter