ITfComposition::EndComposition method (msctf.h)

Terminates a composition.

Syntax

HRESULT EndComposition(
  [in] TfEditCookie ecWrite
);

Parameters

[in] ecWrite

Contains an edit cookie that identifies the edit context obtained from ITfEditSession::DoEditSession.

Return value

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.

Remarks

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.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header msctf.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfContextOwnerCompositionServices::TerminateComposition, ITfComposition interface, ITfEditSession::DoEditSession