ITfComposition::ShiftEnd method (msctf.h)

Article
02/22/2024

Moves the end anchor of a composition.

Syntax

HRESULT ShiftEnd(
  [in] TfEditCookie ecWrite,
  [in] ITfRange     *pNewEnd
);

Parameters

[in] ecWrite

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

[in] pNewEnd

Pointer to an ITfRange object that contains the new end anchor position. The end anchor of the context will be moved to the end anchor of this range. This method fails if the end anchor of this range is positioned prior to the start anchor of the composition.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_FAIL	An unspecified error occurred.
E_INVALIDARG	The end anchor of pNewEnd is positioned prior to the start anchor of the composition or pNewStart is invalid.
E_UNEXPECTED	The composition has already terminated.
TF_E_NOLOCK	The edit context identified by ecWrite does not have a read/write lock.

Remarks

This method causes the GUID_PROP_COMPOSING property to be removed from any text removed from the composition. Likewise, the GUID_PROP_COMPOSING property is also added to any text added to 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