ITextStoreACP::Metode GetText (textstor.h)

Artikel
03/08/2023

Metode ITextStoreACP::GetText mengembalikan informasi tentang teks pada posisi karakter tertentu. Metode ini mengembalikan teks yang terlihat dan tersembunyi dan menunjukkan apakah data yang disematkan dilampirkan ke teks.

Sintaks

HRESULT GetText(
  [in]  LONG       acpStart,
  [in]  LONG       acpEnd,
  [out] WCHAR      *pchPlain,
  [in]  ULONG      cchPlainReq,
  [out] ULONG      *pcchPlainRet,
  [out] TS_RUNINFO *prgRunInfo,
  [in]  ULONG      cRunInfoReq,
  [out] ULONG      *pcRunInfoRet,
  [out] LONG       *pacpNext
);

Parameter

[in] acpStart

Menentukan posisi karakter awal.

[in] acpEnd

Menentukan posisi karakter akhir. Jika parameter ini adalah -1, maka kembalikan semua teks di penyimpanan teks.

[out] pchPlain

Menentukan buffer untuk menerima data teks biasa. Jika parameter ini ADALAH NULL, parameter cchPlainReq harus 0.

[in] cchPlainReq

Menentukan jumlah karakter teks biasa yang diteruskan ke metode .

[out] pcchPlainRet

Menerima jumlah karakter yang disalin ke dalam buffer teks biasa. Parameter ini tidak boleh NULL. Gunakan parameter jika nilai tidak diperlukan.

[out] prgRunInfo

Menerima array struktur TS_RUNINFO . Mungkin NULL hanya jika cRunInfoReq = 0.

[in] cRunInfoReq

Menentukan ukuran, dalam karakter, buffer eksekusi teks.

[out] pcRunInfoRet

Menerima jumlah struktur TS_RUNINFO yang ditulis ke buffer eksekusi teks. Parameter ini tidak boleh NULL.

[out] pacpNext

Menerima posisi karakter karakter berikutnya yang belum dibaca. Tidak boleh NULL.

Mengembalikan nilai

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
TF_E_INVALIDPOS	Parameter acpStart atau acpEnd berada di luar teks dokumen.
TF_E_NOLOCK	Pemanggil tidak memiliki kunci baca-saja pada dokumen.

Keterangan

Pemanggil yang menggunakan metode ini harus memiliki kunci baca-saja pada dokumen dengan memanggil metode ITextStoreACP::RequestLock . Tanpa kunci baca-saja, metode gagal dan mengembalikan TF_E_NOLOCK.

Aplikasi juga dapat memotong nilai pengembalian metode karena alasan internal. Penelepon harus memeriksa karakter yang dikembalikan dan jumlah eksekusi teks dengan hati-hati untuk mendapatkan nilai pengembalian yang diperlukan. Jika nilai yang dikembalikan tidak lengkap, berulang kali panggil metode hingga nilai yang dikembalikan selesai.

Pemanggil hanya dapat meminta teks biasa dengan mengatur parameter cRunInfoReq ke 0 dan parameter prgRunInfo ke NULL. Pemanggil hanya dapat meminta data eksekusi teks dengan mengatur parameter cchPlainReq ke 0 dan parameter pchPlain ke NULL. Namun, penelepon masih harus menyediakan nilai non-null yang valid untuk pcchPlainRet, bahkan jika parameter ini tidak digunakan.

Jika acpEnd adalah -1, maka acpEnd harus ditangani seolah-olah diatur di akhir aliran. Jika tidak, akan lebih besar dari atau sama dengan nol.

Saat keluar, pacpNext harus diatur ke posisi karakter karakter berikutnya dalam aliran yang tidak dirujuk oleh nilai yang dikembalikan. Penelepon akan menggunakan ini untuk memindai teks dengan cepat dengan beberapa panggilan ITextStoreACP::GetText.

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	textstor.h
DLL	Msctf.dll
Redistribusi	TSF 1.0 di Windows 2000 Professional

Lihat juga

ITextStoreACP

ITextStoreACP::RequestLock

Nilai Pengembalian Manajer

TS_RUNINFO

Bagikan melalui