Metode ITfContext::RequestEditSession (msctf.h)

  • Artikel

Mendapatkan akses ke teks dokumen dan properti.

Sintaks

HRESULT RequestEditSession(
  [in]  TfClientId     tid,
  [in]  ITfEditSession *pes,
  [in]  DWORD          dwFlags,
  [out] HRESULT        *phrSession
);

Parameter

[in] tid

Berisi nilai TfClientId yang mengidentifikasi klien untuk membuat sesi edit.

[in] pes

Arahkan ke antarmuka ITfEditSession yang dipanggil untuk melakukan sesi edit.

[in] dwFlags

Berisi satu atau beberapa nilai berikut.

Nilai Makna
TF_ES_ASYNCDONTCARE
 Sesi edit dapat terjadi secara sinkron atau asinkron, atas kebijakan manajer TSF. Manajer akan mencoba menjadwalkan sesi edit sinkron untuk meningkatkan performa. Nilai ini tidak dapat digabungkan dengan nilai TF_ES_ASYNC atau TF_ES_SYNC.
TF_ES_SYNC
 Sesi edit harus sinkron atau permintaan akan gagal (dengan TF_E_SYNCHRONOUS). Bendera ini hanya boleh digunakan dalam situasi yang di dokumentasikan (seperti penanganan penekanan tombol) di mana bendera ini dapat diharapkan berhasil. Jika tidak, panggilan kemungkinan akan gagal. Nilai ini tidak dapat digabungkan dengan nilai TF_ES_ASYNCDONTCARE atau TF_ES_ASYNC.
TF_ES_READ
 Meminta akses baca-saja ke konteks.
TF_ES_READWRITE
 Meminta akses baca/tulis ke konteks.
TF_ES_ASYNC
 Sesi edit harus asinkron atau permintaan gagal. Nilai ini tidak dapat digabungkan dengan nilai TF_ES_ASYNCDONTCARE atau TF_ES_SYNC.

[out] phrSession

Alamat nilai HRESULT yang menerima hasil permintaan sesi edit. Nilai yang diterima tergantung pada jenis sesi edit yang diminta.

  • Jika sesi edit asinkron diminta dan dapat dibuat, menerima TF_S_ASYNC.
  • Jika sesi edit sinkron diminta dan tidak dapat dibuat, menerima TF_E_SYNCHRONOUS.
  • Jika bendera TF_ES_READWRITE ditentukan dan dokumen bersifat baca-saja, menerima TS_E_READONLY.
  • Jika sesi edit sinkron dibuat, menerima nilai pengembalian ITfEditSession::D oEditSession.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai Deskripsi
S_OK
 Metode berhasil. phrSession berisi lebih banyak data hasil untuk metode ini.
TF_E_LOCKED
 Pemanggil berada dalam konteks layanan teks lain yang sudah memegang kunci.
TF_E_DISCONNECTED
 Konteks tidak ada di tumpukan dokumen.
E_INVALIDARG
 Satu atau beberapa parameter tidak valid.
E_OUTOFMEMORY
 Terjadi kegagalan alokasi memori.

Keterangan

Sesi edit asinkron yang tertunda diproses dalam urutan yang diterima. Sesi edit sinkron diproses sebelum sesi pengeditan asinkron yang tertunda.

Layanan teks dapat meminta sesi edit dalam konteks sesi edit yang ada, asalkan sesi akses tulis tidak diminta dalam sesi baca-saja. Panggilan ke metode ini dalam konteks sesi edit yang dibuat oleh layanan teks lain akan gagal dengan TF_E_LOCKED.

Permintaan baca/tulis sinkron akan gagal jika dibuat saat memproses salah satu pemberitahuan berikut.

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 ITfContext, antarmuka ITfEditSession, ITfStatusSink::OnStatusChange, ITfTextEditSink::OnEndEdit, ITfTextLayoutSink::OnLayoutChange