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

ITfEditSession

COM
IIDaa80e803-2021-11d2-93e0-0060b067b86e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfEditSession インターフェイスはテキストサービスによって実装され、コンテキストのテキストやプロパティを読み取ったり変更したりするために TSF マネージャーが使用します。

解説(Remarks)

テキストサービスは ITfContext::RequestEditSession を呼び出し、ITfEditSession インターフェイスへのポインターを渡すことで編集セッションを開始します。編集セッションが許可されると、TSF マネージャーが DoEditSession を呼び出します。

アプリケーションがロックを許可する前にコンテキストが破棄された場合、または呼び出し元のテキストサービスがロックの許可前に非アクティブ化された場合、DoEditSession メソッドは呼び出されません。このため、テキストサービスは編集セッションのクリーンアップ処理を DoEditSession メソッドではなく ITfEditSession インターフェイスのデストラクターで行うようにしてください。

メソッド 1

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

vtbl 3 HRESULT DoEditSession(DWORD ec)

ITfEditSession::DoEditSession メソッド

ecDWORDin編集セッションを一意に識別する TfEditCookie 値を格納します。このクッキーは、ITfRange::GetText などのメソッドでコンテキストにアクセスするために使用します。

戻り値

このメソッドは次のいずれかの値を返すことがあります。

説明
S_OK
メソッドは成功しました。
E_FAIL
不特定のエラーが発生しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfEditSession "{AA80E803-2021-11D2-93E0-0060B067B86E}"
#usecom global ITfEditSession IID_ITfEditSession "{}"
#comfunc global ITfEditSession_DoEditSession  3 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。