ITextStoreACP2::Metode GetText (textstor.h)
Mendapatkan info 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 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 karakter berikutnya yang belum dibaca. Tidak boleh NULL.
Mengembalikan nilai
Metode ini dapat mengembalikan salah satu nilai ini.
Nilai | Deskripsi |
---|---|
|
Metode berhasil. |
|
Parameter acpStart atau acpEnd berada di luar teks dokumen. |
|
Pemanggil tidak memiliki kunci baca-saja pada dokumen. |
Keterangan
Penelepon yang menggunakan metode ini harus memiliki kunci baca-saja pada dokumen dengan memanggil metode RequestLock . Tanpa kunci baca-saja, metode gagal dan mengembalikan TF_E_NOLOCK.
Aplikasi juga dapat memotong nilai pengembalian metode karena alasan internal. Penelepon harus hati-hati memeriksa karakter yang dikembalikan dan jumlah eksekusi teks untuk mendapatkan nilai pengembalian yang diperlukan. Jika nilai yang dikembalikan tidak lengkap, panggil metode berulang kali 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, itu 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. Pemanggil akan menggunakan ini untuk memindai teks dengan cepat dengan beberapa panggilan GetText .
Persyaratan
Klien minimum yang didukung | Windows 8 [aplikasi desktop | Aplikasi UWP] |
Server minimum yang didukung | Windows Server 2012 [aplikasi desktop | Aplikasi UWP] |
Target Platform | Windows |
Header | textstor.h |
DLL | Msctf.dll |
Lihat juga
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk