ITfRangeBackup::Restore method (msctf.h)

Restores a specified range object into the TSF context.

Syntax

HRESULT Restore(
  [in] TfEditCookie ec,
  [in] ITfRange     *pRange
);

Parameters

[in] ec

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

[in] pRange

Pointer to an ITfRange object that receives the backup information. If this parameter is NULL, the backup information is restored into a copy of the range originally backed up by ITfContext::CreateRangeBackup.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.
TF_E_DISCONNECTED
The context is not on a document stack.
TF_E_NOLOCK
The edit cookie specified by ec is invalid.
E_FAIL
An unspecified error occurred.
E_INVALIDARG
pRange 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

ITfContext::CreateRangeBackup

ITfEditSession::DoEditSession

ITfRange

ITfRangeBackup

Ranges: Clones and Backups