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

ITfCleanupContextSink

COM
📘 Microsoft Learn (日本語) · English
IID01689689-7acb-4e9b-ab7c-7ea46b12b522継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfCleanupContextSink インターフェイスは、コンテキストのクリーンアップ操作が発生したときに通知を受け取るために、テキストサービスが実装します。この通知シンクは、IID_ITfCleanupContextSink を指定して ITfSourceSingle::AdviseSingleSink を呼び出すことでインストールされます。

解説(Remarks)

コンテキストのクリーンアップは、次の場合に発生します。

メソッド 1

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

vtbl 3 HRESULT OnCleanupContext(DWORD ecWrite, ITfContext* pic)

ITfCleanupContextSink::OnCleanupContext メソッド

ecWriteDWORDinクリーンアップされた編集コンテキストを識別する TfEditCookie 値を格納します。この編集コンテキストには読み取り/書き込みロックが確保されていることが保証されます。
picITfContext*inクリーンアップされたコンテキストを表す ITfContext インターフェイスへのポインターです。

戻り値

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

解説(Remarks)

コンテキストのクリーンアップは、次の場合に発生します。

ITfCleanupContextDurationSink::OnStartCleanupContext は、TSF マネージャーが ITfCleanupContextSink::OnCleanupContext の通知を開始する直前に呼び出されます。すべての OnCleanupContext 通知が完了すると、TSF マネージャーは OnEndCleanupContext を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfCleanupContextSink "{01689689-7ACB-4E9B-AB7C-7EA46B12B522}"
#usecom global ITfCleanupContextSink IID_ITfCleanupContextSink "{}"
#comfunc global ITfCleanupContextSink_OnCleanupContext  3 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。