Edit

Share via

VSS_WRITERRESTORE_ENUM enumeration (vswriter.h)

  • Article

The VSS_WRITERRESTORE_ENUM enumeration is used by a writer to indicate to a requester the conditions under which it will handle events generated during a restore operation.

Syntax

typedef enum VSS_WRITERRESTORE_ENUM {
  VSS_WRE_UNDEFINED = 0,
  VSS_WRE_NEVER,
  VSS_WRE_IF_REPLACE_FAILS,
  VSS_WRE_ALWAYS
} ;

Constants

 
VSS_WRE_UNDEFINED
Value: 0
It is not known whether the writer will perform special operations during the restore operation.


This state indicates a writer error.
VSS_WRE_NEVER
The writer does not require restore events.
VSS_WRE_IF_REPLACE_FAILS
Indicates that the writer always expects to handle a
PreRestore
(CvssWriter::OnPreRestore) event, but expects
to handle a PostRestore event
(CvssWriter::OnPostRestore) only if a restore
fails when implementing either a VSS_RME_RESTORE_IF_NOT_THERE or
VSS_RME_RESTORE_IF_CAN_REPLACE restore method
(VSS_RESTOREMETHOD_ENUM).
VSS_WRE_ALWAYS
The writer always performs special operations during the restore operation.

Remarks

A writer passes a value of VSS_WRITERRESTORE_ENUM to IVssCreateWriterMetadata::SetRestoreMethod to indicate through its metadata how it interacts with requesters during a restore operation.

A requester retrieves information about a writer's participation by calling IVssExamineWriterMetadata::GetRestoreMethod.

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

IVssCreateWriterMetadata::SetRestoreMethod

IVssExamineWriterMetadata::GetRestoreMethod

VSS_RESTOREMETHOD_ENUM