ITfContext::GetStart method

Syntax


HRESULT GetStart(
  [in]  TfEditCookie ec,
  [out] ITfRange     **ppStart
);

Parameters

ec [in]

Contains an edit cookie that identifies the edit session. This is the value passed to ITfEditSession::DoEditSession.

ppStart [out]

Pointer to an ITfRange interface that receives an empty range positioned at the start of the document.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

TF_E_NOLOCK

The cookie in ec is invalid.

TF_E_DISCONNECTED

The context is not on a document stack.

E_INVALIDARG

One or more parameters are invalid.

E_NOTIMPL

The context owner does not implement this method.

E_OUTOFMEMORY

A memory allocation failure occurred.

E_FAIL

An unspecified error occurred.

 

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

Msctf.dll

See also

ITfContext
ITfEditSession::DoEditSession
ITfRange

 

 

Show: