Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfCompositionSink::OnCompositionTerminated method

Syntax


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

Parameters

ecWrite [in]

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

pComposition [in]

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

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Imekrcic.dll

See also

ITfCompositionSink
ITfContextComposition::StartComposition
TfEditCookie
ITfComposition

 

 

Community Additions

Show:
© 2015 Microsoft