Win32 API 日本語リファレンス
ホーム › UI.TextServices › ITfTextEditSink

ITfTextEditSink

COM
📘 Microsoft Learn (日本語) · English
IID8127d409-ccd3-4683-967a-b43d5b482bf7継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfTextEditSink インターフェイスは、読み取り/書き込みアクセスを伴う編集セッションの完了を通知します。

メソッド 1

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT OnEndEdit(ITfContext* pic, DWORD ecReadOnly, ITfEditRecord* pEditRecord)

ITfTextEditSink::OnEndEdit メソッド

picITfContext*in編集されたコンテキストの ITfContext インターフェイスへのポインターです。
ecReadOnlyDWORDinコンテキストへの読み取り専用アクセスを表す TfEditCookie 値を指定します。
pEditRecordITfEditRecord*inコンテキストへの変更内容にアクセスするために使用する ITfEditRecord インターフェイスへのポインターです。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

読み取り/書き込みアクセスを伴う編集セッションは、TF_ES_READWRITE フラグを指定して ITfContext::RequestEditSession メソッドを呼び出すことで要求され、これによりセッションを実行する ITfEditSession::DoEditSession メソッドが設定されます。その ITfEditSession::DoEditSession メソッドが完了すると、TSF はこのメソッドを呼び出します。

テキストサービスは、ecReadOnly パラメーターをコンテキストの参照にのみ使用できます。変更が必要な場合、テキストサービスは ITfContext::RequestEditSession メソッドを非同期に呼び出す必要があります。ただし、テキストサービスは、自身がコンポジションの一部として以前に入力したテキストのみを変更するべきです。そうしないと、複数のテキストサービスが同じテキストを繰り返し変更してしまう可能性があります。テキストサービスは、ITfContext::InWriteSession メソッドを使用して、完了した編集セッションを自身が実行したかどうかを判断できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

#define global IID_ITfTextEditSink "{8127D409-CCD3-4683-967A-B43D5B482BF7}"
#usecom global ITfTextEditSink IID_ITfTextEditSink "{}"
#comfunc global ITfTextEditSink_OnEndEdit  3 sptr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。