IVssBackupComponents::AbortBackup method (vsbackup.h)

The AbortBackup method notifies VSS that a backup operation was terminated.

This method must be called if a backup operation terminates after the creation of a shadow copy set with IVssBackupComponents::StartSnapshotSet and before IVssBackupComponents::DoSnapshotSet returns.

If AbortBackup is called and no shadow copy or backup operations are underway, it is ignored.

Syntax

HRESULT AbortBackup();

The following are the valid return codes for this method.

Value	Meaning
S_OK	The query operation was successful.
E_OUTOFMEMORY	The caller is out of memory or other system resources.
VSS_E_BAD_STATE	The backup components object is not initialized.
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.

AbortBackup generates an Abort event, which is handled by each instance of each writer through the CVssWriter::OnAbort method.

Requirement	Value
Minimum supported client	Windows XP [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