ITfContextComposition::Metode StartComposition (msctf.h)

Artikel
03/08/2023

Membuat komposisi baru.

Sintaks

HRESULT StartComposition(
  [in]  TfEditCookie       ecWrite,
  [in]  ITfRange           *pCompositionRange,
  [in]  ITfCompositionSink *pSink,
  [out] ITfComposition     **ppComposition
);

Parameter

[in] ecWrite

Berisi cookie edit yang mengidentifikasi konteks edit. Ini diperoleh dari ITfEditSession::D oEditSession.

[in] pCompositionRange

Penunjuk ke objek ITfRange yang menentukan teks yang awalnya dicakup komposisi.

[in] pSink

Arahkan ke objek ITfCompositionSink yang menerima pemberitahuan peristiwa komposisi. Parameter ini bersifat opsional dan dapat berupa NULL. Jika disediakan, objek dilepaskan ketika komposisi dihentikan.

[out] ppComposition

Penunjuk ke penunjuk antarmuka ITfComposition yang menerima objek komposisi baru. Parameter ini menerima NULL jika pemilik konteks menolak komposisi.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil. Jika komposisi pemilik konteks menyarankan sink menolak komposisi, ppComposition diatur ke NULL.
E_FAIL	Terjadi kesalahan yang tidak ditentukan.
E_INVALIDARG	Satu atau beberapa parameter tidak valid.
E_OUTOFMEMORY	Objek komposisi tidak dapat dibuat.
E_UNEXPECTED	Metode ini dipanggil dalam operasi komposisi lain.
TF_E_DISCONNECTED	Objek konteks tidak ada di tumpukan dokumen.
TF_E_NOLOCK	Konteks edit yang diidentifikasi oleh ecWrite tidak memiliki kunci baca/tulis.

Keterangan

Jika pemilik konteks telah menginstal sink saran komposisi pemilik konteks, metode ITfContextOwnerCompositionSink::OnStartComposition dipanggil. Jika sink saran menolak komposisi baru, metode ini mengembalikan S_OK tetapi ppComposition diatur ke NULL.

Teks apa pun yang dicakup oleh pCompositionRange menerima properti GUID_PROP_COMPOSING.

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

Lihat juga

Antarmuka IEnumITfCompositionView, antarmuka ITfContextComposition, antarmuka ITfRange, antarmuka ITfCompositionSink, ITfContextOwnerCompositionSink::OnStartComposition, ITfEditSession::D oEditSession

Bagikan melalui