VSS_WRITER_STATE enumeration (vss.h)

  • Article

The VSS_WRITER_STATE enumeration indicates the current state of the writer.

Syntax

typedef enum _VSS_WRITER_STATE {
  VSS_WS_UNKNOWN = 0,
  VSS_WS_STABLE,
  VSS_WS_WAITING_FOR_FREEZE,
  VSS_WS_WAITING_FOR_THAW,
  VSS_WS_WAITING_FOR_POST_SNAPSHOT,
  VSS_WS_WAITING_FOR_BACKUP_COMPLETE,
  VSS_WS_FAILED_AT_IDENTIFY,
  VSS_WS_FAILED_AT_PREPARE_BACKUP,
  VSS_WS_FAILED_AT_PREPARE_SNAPSHOT,
  VSS_WS_FAILED_AT_FREEZE,
  VSS_WS_FAILED_AT_THAW,
  VSS_WS_FAILED_AT_POST_SNAPSHOT,
  VSS_WS_FAILED_AT_BACKUP_COMPLETE,
  VSS_WS_FAILED_AT_PRE_RESTORE,
  VSS_WS_FAILED_AT_POST_RESTORE,
  VSS_WS_FAILED_AT_BACKUPSHUTDOWN,
  VSS_WS_COUNT
} VSS_WRITER_STATE, *PVSS_WRITER_STATE;

Constants

 
VSS_WS_UNKNOWN
Value: 0
The writer's state is not known.


This indicates an error on the part of the writer.
VSS_WS_STABLE
The writer has completed processing current shadow copy events and is ready to proceed, or
CVssWriter::OnPrepareSnapshot has not yet
been called.
VSS_WS_WAITING_FOR_FREEZE
The writer is waiting for the freeze state.
VSS_WS_WAITING_FOR_THAW
The writer is waiting for the thaw state.
VSS_WS_WAITING_FOR_POST_SNAPSHOT
The writer is waiting for the
PostSnapshot state.
VSS_WS_WAITING_FOR_BACKUP_COMPLETE
The writer is waiting for the requester to finish its backup operation.
VSS_WS_FAILED_AT_IDENTIFY
The writer vetoed the shadow copy creation process at the writer identification state.
VSS_WS_FAILED_AT_PREPARE_BACKUP
The writer vetoed the shadow copy creation process during the backup preparation state.
VSS_WS_FAILED_AT_PREPARE_SNAPSHOT
The writer vetoed the shadow copy creation process during the PrepareForSnapshot state.
VSS_WS_FAILED_AT_FREEZE
The writer vetoed the shadow copy creation process during the freeze state.
VSS_WS_FAILED_AT_THAW
The writer vetoed the shadow copy creation process during the thaw state.
VSS_WS_FAILED_AT_POST_SNAPSHOT
The writer vetoed the shadow copy creation process during the
PostSnapshot state.
VSS_WS_FAILED_AT_BACKUP_COMPLETE
The shadow copy has been created and the writer failed during the
BackupComplete state. A writer
should save information about this failure to the error log. For additional information on logging, see
Event and Error Handling Under VSS.
VSS_WS_FAILED_AT_PRE_RESTORE
The writer failed during the
PreRestore state.
VSS_WS_FAILED_AT_POST_RESTORE
The writer failed during the
PostRestore state.
VSS_WS_FAILED_AT_BACKUPSHUTDOWN
The writer failed during the shutdown of the backup application.
VSS_WS_COUNT
Reserved value.

Remarks

A requester determines the state of a writer through IVssBackupComponents::GetWriterStatus.

Requirements

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

See also

CVssWriter::OnPrepareSnapshot

IVssBackupComponents::GetWriterStatus