IVssBackupComponents::SetRestoreState method (vsbackup.h)

Article
02/22/2024

The SetRestoreState method defines an overall configuration for a restore operation.

Syntax

HRESULT SetRestoreState(
  [in] VSS_RESTORE_TYPE restoreType
);

Parameters

[in] restoreType

A VSS_RESTORE_TYPE enumeration value indicating the type of restore to be performed.

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully set the backup state.
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 backup components object is not initialized, this method has been called during a backup operation, or this method has not been called within the correct sequence.
VSS_E_INVALID_XML_DOCUMENT	The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS.
VSS_E_UNEXPECTED	Unexpected error. The error code is logged in the error log file. For more information, see Event and Error Handling Under VSS. Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead.

Remarks

Typically, most restore operations will not need to override the default restore type (VSS_RTYPE_UNDEFINED). Writers should treat this restore type as if it were VSS_RTYPE_BY_COPY.

If applications need to call SetRestoreState, it should be called prior to calling IVssBackupComponents::PreRestore.

If SetRestoreState is not called prior to IVssBackupComponents::PreRestore, the default restore state () is used.

Requirements

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