ホーム › UI.TextServices › ITfCompositionSink
ITfCompositionSink
COM公式ドキュメント
ITfCompositionSink インターフェイスは、コンポジションが終了したときに通知を受け取るためにテキストサービスが実装します。
メソッド 1
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
vtbl 3 HRESULT OnCompositionTerminated(DWORD ecWrite, ITfComposition* pComposition)
ITfCompositionSink::OnCompositionTerminated メソッド
| ecWrite | DWORD | in | 編集コンテキストを識別する TfEditCookie 値を格納します。これは ITfContextComposition::StartComposition の呼び出しで ecWrite に渡された値と同じです。 |
| pComposition | ITfComposition* | in | 終了した ITfComposition オブジェクトへのポインターです。 |
戻り値
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
このメソッドが呼び出されたとき、TSF テキストサービスに必須の処理はありません。TSF テキストサービスはこの通知を利用して、部分的に変換された文字列を読み取り可能なテキストに戻したり、コンポジションを完全に消去したりできます。TSF マネージャーは、対象のテキストに設定された GUID_PROP_COMPOSING プロパティの値を自動的にクリアします。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ITfCompositionSink "{A781718C-579A-4B15-A280-32B8577ACC5E}"
#usecom global ITfCompositionSink IID_ITfCompositionSink "{}"
#comfunc global ITfCompositionSink_OnCompositionTerminated 3 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。