ITfComposition::EndComposition method (Windows)

Switch View :

ScriptFree

ITfComposition::EndComposition method

Applies to: desktop apps | Metro style apps

HRESULT EndComposition(
  [in]  TfEditCookie ecWrite
);

ecWrite [in]: Contains an edit cookie that identifies the edit context obtained from ITfEditSession::DoEditSession.

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_UNEXPECTED	This value results when: The composition terminated. The caller is inside another composition write operation. The caller does not own the composition.
TF_E_NOLOCK	The edit context identified by ecWrite does not have a read/write lock.

Value

Description

The method was successful.

This value results when:

The edit context identified by ecWrite does not have a read/write lock.

This method does not release the composition object, but the ITfComposition methods will fail with E_UNEXPECTED after this method is called.

Context owners should use the ITFContextOwnerCompositionServices::TerminateComposition method to terminate a composition.

This method causes the GUID_PROP_COMPOSING property to be removed from the text covered by the composition.