Metode ITextStoreAnchor::SetText (textstor.h)

Artikel
03/02/2024

Metode ITextStoreAnchor::SetText mengatur pilihan teks di antara dua lokasi jangkar yang disediakan.

Sintaks

HRESULT SetText(
  [in] DWORD       dwFlags,
  [in] IAnchor     *paStart,
  [in] IAnchor     *paEnd,
  [in] const WCHAR *pchText,
  [in] ULONG       cch
);

Parameter

[in] dwFlags

Jika diatur ke nilai TS_ST_CORRECTION, teks adalah transformasi (koreksi) konten yang ada, dan informasi markup teks khusus (metadata) dipertahankan, seperti .wav data file atau pengidentifikasi bahasa. Klien menentukan jenis informasi markup yang akan dipertahankan.

[in] paStart

Arahkan ke jangkar di awal rentang teks yang akan diganti.

[in] paEnd

Arahkan ke jangkar di akhir rentang teks untuk diganti. Harus selalu mengikuti atau berada pada posisi yang sama dengan paStart.

[in] pchText

Arahkan ke teks pengganti. String teks tidak harus null dihentikan, karena jumlah karakter teks ditentukan dalam parameter cch .

[in] cch

Menentukan jumlah karakter dalam teks pengganti.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
E_FAIL	Metode ini tidak dapat membuat instans salah satu jangkar paStart atau paEnd.
TS_E_INVALIDPOS	Lokasi paStart atau paEnd berada di luar teks dokumen.
TS_E_NOLOCK	Pemanggil tidak memiliki kunci baca/tulis.
TS_E_READONLY	Dokumen bersifat baca-saja. Isi tidak dapat dimodifikasi.
TS_E_REGION	Upaya dilakukan untuk mengubah teks di seluruh batas wilayah.

Keterangan

Aplikasi harus memulai komposisi dengan terlebih dahulu menggunakan ITextStoreAnchor::InsertTextAtSelection. ITextStoreAnchor::SetText harus digunakan hanya dalam komposisi yang ada. Jika tidak ada komposisi aktif pada saat SetText dipanggil, manajer TSF membuat komposisi yang berlangsung cukup lama untuk membungkus panggilan ke SetText.

Penelepon harus menahan kunci tulis yang diperoleh melalui ITextStoreAnchor::RequestLock. Jika tidak, ITextStoreAnchor::SetText akan gagal dengan TS_E_NOLOCK.

Jika paStart berada di lokasi yang sama dengan paEnd, maka operasi adalah penyisipan, dan tidak ada teks yang ada yang akan dihapus.

TS_CHAR_EMBEDDED tidak dapat diteruskan ke metode ini. Untuk objek yang disematkan, gunakan ITextStoreAnchor::InsertEmbedded sebagai gantinya.

Metode ini akan gagal jika rentang teks yang diganti mencakup batas wilayah apa pun. Sebaliknya, penelepon harus melakukan beberapa panggilan ke metode , satu untuk setiap wilayah.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	textstor.h
DLL	Msctf.dll
Redistribusi	TSF 1.0 di Windows 2000 Professional