ITfRange::SetGravity method (msctf.h)

Sets the gravity of the anchors in the object.

Syntax

HRESULT SetGravity(
  [in] TfEditCookie ec,
  [in] TfGravity    gStart,
  [in] TfGravity    gEnd
);

Parameters

[in] ec

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

[in] gStart

Contains one of the TfGravity values that specifies the gravity of the start anchor.

[in] gEnd

Contains one of the TfGravity values that specifies the gravity of the end anchor.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.
E_FAIL
An unspecified error occurred.
TF_E_NOLOCK
The cookie in ec is invalid.

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

See also

Anchor Gravity

ITfDocumentMgr::CreateContext

ITfEditSession::DoEditSession

ITfRange

ITfRange::GetGravity

TfGravity