ホーム › UI.TextServices › ITfContextOwnerCompositionServices

ITfContextOwnerCompositionServices

COM

IID86462810-593b-4916-9764-19c08e9ce110継承元ITfContextComposition自前メソッド開始 vtbl7

公式ドキュメント

ITfContextOwnerCompositionServices インターフェイスは TSF マネージャーによって実装され、コンテキストの所有者がテキストサービスによって作成されたコンポジションを操作するために使用します。

解説(Remarks)

通常、アプリケーションがコンテキストを作成し、そのコンテキストの所有者となります。場合によってはテキストサービスがコンテキストを作成することがあり、その場合はテキストサービスがコンテキストの所有者になります。詳細については、Edit Contexts を参照してください。

このインターフェイスは、ITfContext::QueryInterface を IID_ITfContextOwnerCompositionServices で呼び出して取得します。

例

ITfContext


HRESULT hr;
ITfContextOwnerCompositionServices *pCompServices;

//ITfContextOwnerCompositionServices インターフェイスポインターを取得します。 
hr = m_pContext->QueryInterface(IID_ITfContextOwnerCompositionServices, (LPVOID*)&pCompServices);
if(SUCCEEDED(hr))
{
    //インターフェイスを使用します。 

    //インターフェイスを解放します。 
    pCompServices->Release();
}

メソッド 1

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

vtbl 7 HRESULT TerminateComposition(ITfCompositionView* pComposition)

ITfContextOwnerCompositionServices::TerminateComposition メソッド

pComposition

ITfCompositionView*

終了するコンポジションを表す ITfCompositionView インターフェイスへのポインター。この値が NULL の場合、コンテキスト内のすべてのコンポジションが終了します。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
TF_E_DISCONNECTED	コンテキストがドキュメントスタック上にありません。
TF_E_NOLOCK	テキストサービスが現在ドキュメントのロックを保持しています。
E_UNEXPECTED	このメソッドが別のコンポジション操作の実行中に呼び出されました。
E_FAIL	原因不明のエラーが発生しました。

解説(Remarks)

テキストサービスは、自身が作成したコンポジションを終了するために ITfComposition::EndComposition を使用します。

コンテキストの所有者がテキストストアを実装している場合、このメソッドを呼び出す前に同期書き込みロックを許可できる状態でなければなりません。

このメソッドは次の処理も行います。

終了した各コンポジションについて、インストールされているすべてのコンポジションアドバイズシンクに対して ITfCompositionSink::OnCompositionTerminated が呼び出されます。
コンテキストの所有者がコンテキストオーナーコンポジションアドバイズシンクをインストールしている場合、終了した各コンポジションについて ITfContextOwnerCompositionSink::OnEndComposition が呼び出されます。
終了した各コンポジションが対象としていたテキストについて、GUID_PROP_COMPOSING プロパティがクリアされます。

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