Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfContext::CreateRangeBackup method

Syntax


HRESULT CreateRangeBackup(
  [in]   TfEditCookie ec,
  [in]   ITfRange *pRange,
  [out]  ITfRangeBackup **ppBackup
);

Parameters

ec [in]

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

pRange [in]

Pointer to the ITfRange object to be backed up.

ppBackup [out]

Pointer to an ITfRangeBackup interface pointer that receives the backup of pRange.

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_OUTOFMEMORY

A memory allocation failure occurred.

E_FAIL

An unspecified error occurred.

 

Remarks

This method creates a copy of the range that it can use to restore the data in ITfRangeBackup::Restore.

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
ITfRangeBackup
ITfRangeBackup::Restore
Ranges: Clones and Backups

 

 

Community Additions

Show:
© 2014 Microsoft