Edit

ITfContextOwnerCompositionSink::OnUpdateComposition method (msctf.h)

  • Article

Called when an existing composition is changed.

Syntax

HRESULT OnUpdateComposition(
  [in] ITfCompositionView *pComposition,
  [in] ITfRange           *pRangeNew
);

Parameters

[in] pComposition

Pointer to an ITfCompositionView object that represents the composition updated.

[in] pRangeNew

Pointer to an ITfRange object that contains the range of text the composition will cover after the composition is updated.

Return value

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

Remarks

To determine what has changed within the composition, compare pRangeNew with the range returned from ITfCompositionView::GetRange. The range returned by ITfCompositionView::GetRange is not updated until after ITfContextOwnerCompositionSink::OnUpdateComposition returns.

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

See also

ITfCompositionView interface, ITfContextOwnerCompositionSink interface, ITfCompositionView::GetRange, ITfRange interface