ITfContextOwnerCompositionServices::TerminateComposition メソッド (msctf.h)

コンポジションを終了します。

構文

HRESULT TerminateComposition(
  [in] ITfCompositionView *pComposition
);

[in] pComposition

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

このメソッドは、これらの値のいずれかを返すことができます。

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

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

コンテキスト所有者がテキストストアを実装する場合、コンテキスト所有者は、このメソッドを呼び出す前に同期書き込みロックを許可できる必要があります。

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

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

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	msctf.h
[DLL]	Msctf.dll
再頒布可能パッケージ	Windows 2000 Professional 上の TSF 1.0