ITfComposition::EndComposition メソッド (msctf.h)

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

構文

HRESULT EndComposition(
  [in] TfEditCookie ecWrite
);

パラメーター

[in] ecWrite

ITfEditSession::D oEditSession から取得した編集コンテキストを識別する編集 Cookie が含まれています。

戻り値

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

説明
S_OK
メソッドは正常に実行されました。
E_UNEXPECTED
この値は、次の場合に発生します。
  • コンポジションが終了しました。
  • 呼び出し元は、別のコンポジション書き込み操作内にあります。
  • 呼び出し元がコンポジションを所有していません。
TF_E_NOLOCK
ecWrite によって識別される編集コンテキストには、読み取り/書き込みロックがありません。

解説

このメソッドは合成オブジェクトを解放しませんが、 ITfComposition メソッドは、このメソッドの呼び出し後にE_UNEXPECTEDで失敗します。

コンテキスト所有者は 、ITFContextOwnerCompositionServices::TerminateComposition メソッドを使用してコンポジションを終了する必要があります。

このメソッドを使用すると、コンポジションの対象となるテキストからGUID_PROP_COMPOSING プロパティが削除されます。

要件

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

関連項目

ITfContextOwnerCompositionServices::TerminateCompositionITfComposition インターフェイスITfEditSession::D oEditSession