ITfContextOwnerCompositionServices::TerminateComposition method (msctf.h)

Terminates a composition.

Syntax

HRESULT TerminateComposition(
  [in] ITfCompositionView *pComposition
);

Parameters

[in] pComposition

Pointer to a ITfCompositionView interface that represents the composition to terminate. If this value is NULL, all compositions in the context are terminated.

Return value

This method can return one of these values.

Remarks

A text service uses ITfComposition::EndComposition to terminate a composition that it created.

If the context owner implements the text store, the context owner must be able to grant a synchronous write lock before calling this method.

This method also does the following:

• For each composition terminated, ITfCompositionSink::OnCompositionTerminated is called for all installed composition advise sinks.
• If the context owner installed a context owner composition advise sink, ITfContextOwnerCompositionSink::OnEndComposition is called for each terminated composition.
• The GUID_PROP_COMPOSING property will be cleared for the text covered by each terminated composition.

Requirements

See also

ITfComposition::EndComposition, nf-msctf-itfcompositionsink-oncompositionterminated, ITfCompositionView interface, ITfContextOwnerCompositionServices interface, ITfContextOwnerCompositionSink::OnEndComposition