Edit

ITfCompositionSink::OnCompositionTerminated method (msctf.h)

  • Article

Called when a composition is terminated.

Syntax

HRESULT OnCompositionTerminated(
  [in] TfEditCookie   ecWrite,
  [in] ITfComposition *pComposition
);

Parameters

[in] ecWrite

Contains a TfEditCookie value that identifies the edit context. This is the same value passed for ecWrite in the call to ITfContextComposition::StartComposition.

[in] pComposition

Pointer to the ITfComposition object terminated.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

There is no required action for the TSF text service when this method is called. The TSF text service can use this notification to revert partially composed text into readable text or erase the composition entirely. The TSF manager will automatically clear the GUID_PROP_COMPOSING property value over the affected text.

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 Imekrcic.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfComposition interface, ITfCompositionSink interface, ITfContextComposition::StartComposition, TfEditCookie