Edit

ITfContext::CreateRangeBackup method (msctf.h)

  • Article

Creates a backup of a range.

Syntax

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

Parameters

[in] ec

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

[in] pRange

Pointer to the ITfRange object to be backed up.

[out] ppBackup

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

Return value

This method can return one of these values.

Value Description
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

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

ITfContext interface, ITfEditSession::DoEditSession, ITfRange interface, ITfRangeBackup interface, ITfRangeBackup::Restore, Ranges: Clones and Backups