VSS_FILE_RESTORE_STATUS enumeration (vswriter.h)

  • Article

The VSS_FILE_RESTORE_STATUS enumeration defines the set of statuses of a file restore operation performed on the files managed by a selected component or component set (see Working with Selectability and Logical Paths for information on selecting components).

Syntax

typedef enum VSS_FILE_RESTORE_STATUS {
  VSS_RS_UNDEFINED = 0,
  VSS_RS_NONE,
  VSS_RS_ALL,
  VSS_RS_FAILED
} ;

Constants

 
VSS_RS_UNDEFINED
Value: 0
The restore state is undefined.


This value indicates an error, or indicates that a restore operation has not yet started.

This value is not supported for components that are owned by express writers.
VSS_RS_NONE
No files were restored.


This value indicates an error in restoration that did not leave any restored files on disk.
VSS_RS_ALL
All files were restored. This value indicates success and should be set for each component that was
restored successfully.
VSS_RS_FAILED
The restore process failed.


This value indicates an error in restoration that did leave some restored files on disk. This means the
components on disk are now corrupt.

Remarks

If any files managed by a component or, if it defines a component set, any of its subcomponents cannot be restored, the value of VSS_FILE_RESTORE_STATUS must indicate an error.

Both the values VSS_RS_FAILED and VSS_RS_NONE indicate that a restore operation did not complete successfully:

  • VSS_RS_NONE indicates a restore failed gracefully: no files from the component or its subcomponents were restored to disk.
  • VSS_RS_FAIL indicates a restore failed gracelessly, leaving some files restored to disk and some files unrestored.
Requesters must set a restore status (using IVssBackupComponents::SetFileRestoreStatus) for every component (and its component set, if it defines one) explicitly added for restore to the Backup Components Document (using either IVssBackupComponents::SetSelectedForRestore or IVssBackupComponents::AddRestoreSubcomponent).

Writers and requesters can query the status of the restoration of a component or a component set defined by a selectable component with calls to IVssComponent::GetFileRestoreStatus. If this method is called for a component that was not selected, the value returned is undefined.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header vswriter.h

See also

IVssBackupComponents::SetFileRestoreStatus

IVssComponent::GetFileRestoreStatus