Metode ITextStoreACP::SetText (textstor.h)

Artikel
03/02/2024

Metode ITextStoreACP::SetText mengatur pilihan teks ke posisi karakter yang disediakan.

Sintaks

HRESULT SetText(
  [in]  DWORD         dwFlags,
  [in]  LONG          acpStart,
  [in]  LONG          acpEnd,
  [in]  const WCHAR   *pchText,
  [in]  ULONG         cch,
  [out] TS_TEXTCHANGE *pChange
);

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] acpStart

Menentukan posisi karakter awal teks untuk diganti.

[in] acpEnd

Menentukan posisi karakter akhir teks untuk diganti. Parameter ini diabaikan jika nilainya adalah 1.

[in] pchText

Menentukan penunjuk 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.

[out] pChange

Arahkan ke struktur TS_TEXTCHANGE dengan data berikut.

Nilai	Makna
acpStart	Posisi karakter aplikasi awal sebelum teks disisipkan ke dalam dokumen.
acpOldEnd	Posisi akhir sebelum teks disisipkan ke dalam dokumen. Nilai ini sama dengan acpStart untuk titik penyisipan. Jika nilai ini berbeda dari acpStart, maka teks dipilih sebelum penyisipan teks.
acpNewEnd	Posisi akhir setelah penyisipan teks terjadi.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
TS_E_INVALIDPOS	Parameter acpStart atau acpEnd berada di luar teks dokumen.
TS_E_NOLOCK	Penelepon 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 ITextStoreACP::InsertTextAtSelection. ITextStoreACP::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.

Posisi karakter acpStart dan acpEnd tidak dapat berada di luar rentang dokumen.

Aplikasi tidak boleh memanggil metode ITextStoreACPSink::OnTextChange sebagai respons terhadap metode ini.

Metode ini harus memanggil metode ITextStoreACP::SetSelection untuk memilih teks yang akan diubah. Setelah berhasil menjalankan metode ITextStoreACP::SetSelection , metode ini kemudian memanggil metode ITextStoreACP::InsertTextAtSelection untuk melakukan perubahan teks aktual.

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