CVssWriter::OnBackupShutdown method

The OnBackupShutdown method is called by a writer following a BackupShutdown event. It is used to perform operations considered necessary when a backup application shuts down, particularly in the case of a crash of the backup application.

OnBackupShutdown is a virtual method. It is implemented by the CVssWriter base class, but can be overridden by derived classes.

Syntax


bool OnBackupShutdown(
  [in] VSS_ID SnapshotSetId
);

Parameters

SnapshotSetId [in]

Identifier for the shadow copy set involved in the backup operation.

Return value

As implemented by the base class, OnBackupShutdown always returns true

Any other implementation of this method should return true except in the case of a fatal error. If a fatal error occurs, the method must call the CVssWriter::SetWriterFailure method to provide a description of the failure before returning false. If a nonfatal error occurs, the method should still call SetWriterFailure but return true. If the error is caused by a transient problem, the method should specify VSS_E_WRITERERROR_RETRYABLE in the call to SetWriterFailure.

In all cases when a failure occurs, the method should write an event to the event log to report the exact reason for the failure.

Remarks

The default implementation of this method by the CVssWriter base class returns true without performing any other operation.

If special operations are to be performed by the writer when a backup application shuts down, the default implementation can be overridden.

If no shadow copy has been successfully performed, the value of the shadow copy set identifier (SnapshotSetId) will be NULL.

A BackupShutdown event will be generated whenever a backup application actually terminates and its IVssBackupComponents is released.

The BackupComplete event requires the backup application to either successfully complete the backup or fail gracefully; this may not be the case if the backup application is terminated by the system or terminated manually prior to the completion of the backup (for instance, if the backup operation hung and had to be shut down).

Because of this, a BackupShutdown event is a more robust signal of the end of a backup application than the BackupComplete event.

A writer should maintain state information so that it can track whether a BackupComplete event was sent for a given shadow copy set.

Any writer-specific implementation of OnBackupShutdown should check whether a BackupComplete event was handled. It should ensure that all necessary writer cleanup operations following a backup (successful or otherwise) are preformed.

Writers should never throw an exception from this method or any other CVssWriter(Ex)::OnXxx callback method.

If this method calls the CVssWriterEx2::GetSessionId, CVssWriter::SetWriterFailure, or CVssWriterEx2::SetWriterFailureEx method, it must do so in the same thread that called this method. For more information, see Writer Event Handling.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

VsWriter.h (include Vss.h or VsWriter.h)

Library

VssApi.lib

See also

CVssWriter
CVssWriter::OnBackupComplete
CVssWriter::SetWriterFailure
IVssBackupComponents::BackupComplete

 

 

Show: