Edit

IVssComponent::SetRestoreTarget method (vswriter.h)

  • Article

The SetRestoreTarget method sets the restore target (in terms of the VSS_RESTORE_TARGET enumeration) for the current component.

Only a writer can call this method, and only during a restore operation.

Syntax

HRESULT SetRestoreTarget(
  [in] VSS_RESTORE_TARGET target
);

Parameters

[in] target

A value from VSS_RESTORE_TARGET containing the restore target information.

Return value

The following are the valid return codes for this method.

Value Meaning
S_OK
 Successfully set the item.
E_INVALIDARG
 One of the parameter values is not valid.
E_OUTOFMEMORY
 The caller is out of memory or other system resources.
VSS_E_BAD_STATE
 The caller is not in the correct state (either backup or restore) for the operation.

Remarks

The restore target set by SetRestoreTarget applies to all files in the component and any nonselectable subcomponents.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vswriter.h (include Vss.h, VsWriter.h)
Library VssApi.lib

See also

IVssComponent