Metode ITfRange::SetText (msctf.h)

Artikel
03/08/2023

Metode ITfRange::SetText menggantikan konten yang dicakup oleh rentang teks. Untuk objek rentang kosong, metode menghasilkan penyisipan di lokasi rentang. Jika konten baru adalah string kosong (cch = 0), metode akan menghapus konten yang ada dalam rentang.

Sintaks

HRESULT SetText(
  [in] TfEditCookie ec,
  [in] DWORD        dwFlags,
  [in] const WCHAR  *pchText,
  [in] LONG         cch
);

Parameter

[in] ec

Mengidentifikasi konteks edit yang diperoleh dari ITfDocumentMgr::CreateContext atau ITfEditSession::D oEditSession.

[in] dwFlags

Menentukan perilaku opsional untuk koreksi konten. Jika diatur ke nilai TF_ST_CORRECTION, maka operasi adalah koreksi konten yang ada, bukan pembuatan konten baru, dan properti teks asli dipertahankan.

[in] pchText

Penunjuk ke buffer yang berisi teks untuk menggantikan konten rentang.

[in] cch

Berisi jumlah karakter dalam pchText.

Mengembalikan nilai

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
E_FAIL	Terjadi kesalahan yang tidak ditentukan.
E_INVALIDARG	Satu atau beberapa parameter tidak valid.
TF_E_COMPOSITION_REJECTED	Pemilik konteks menolak komposisi default.
TF_E_NOLOCK	Nilai parameter ec adalah cookie yang tidak valid, atau pemanggil tidak memiliki kunci baca/tulis.
TF_E_RANGE_NOT_COVERED	Rentang tidak berada dalam komposisi aktif pemanggil.

Keterangan

Saat rentang mencakup beberapa wilayah, panggil ITfRange::SetText di setiap wilayah secara terpisah. Jika tidak, metode dapat gagal.

Secara default, layanan teks memulai dan mengakhiri komposisi sementara yang mencakup rentang, untuk memastikan bahwa pemilik konteks secara konsisten mengenali komposisi melalui teks yang diedit. Jika pemilik komposisi menolak komposisi default, maka metode mengembalikan TF_E_COMPOSITION_REJECTED. Komposisi default hanya dibuat jika pemanggil belum memulainya. Jika penelepon memiliki komposisi aktif, panggilan gagal.

Karakter tempat penampung objek TF_CHAR_EMBEDDED mungkin tidak diteruskan ke metode ini. ITfRange::InsertEmbedded harus digunakan sebagai gantinya.

Untuk menyisipkan teks, metode ITFInsertAtSelection:InsertTextAtSelection tidak memerlukan rentang pilihan untuk dialokasikan, dan menghindari persyaratan bahwa rentang cocok dengan pilihan.

Persyaratan


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