IVssBackupComponents Interface

The IVssBackupComponents interface is used by a requester to poll writers about file status and to run backup/restore operations.

Applications obtain an instance of the IVssBackupComponents interface by calling CreateVssBackupComponents.

An IVssBackupComponents object can be used for only a single backup, restore, or Query operation.

After the backup, restore, or Query operation has either successfully finished or been explicitly terminated, a requester must release the IVssBackupComponents object by calling IVssBackupComponents::Release. An IVssBackupComponents object must not be reused. For example, you cannot perform a backup or restore operation with the same IVssBackupComponents object that you have already used for a Query operation.

Methods

The IVssBackupComponents interface inherits the methods of the IUnknown interface.

In addition, IVssBackupComponents defines the following methods.

MethodDescription

GetWriterComponentsCount

Gets the number of writer components.

GetWriterComponents

Obtains a specific writer component.

InitializeForBackup

Initializes the backup components metadata file in preparation for backup.

SetBackupState

Defines an overall configuration for a backup operation.

InitializeForRestore

Initializes the IVssBackupComponents interface in preparation for a restore operation.

SetRestoreState

Sets how a restore will be processed.

GatherWriterMetadata

Prompts each writer to send the metadata it has collected.

GetWriterMetadataCount

Returns the number of writers for which there is metadata.

GetWriterMetadata

Returns writer metadata for a specific writer.

FreeWriterMetadata

Frees system resources allocated when GatherWriterMetadata is called.

AddComponent

Adds a component to the list of components to be backed up.

PrepareForBackup

Signals all writers that a backup is about to occur.

AbortBackup

Terminates the current backup.

GatherWriterStatus

Prompts each writer to send a status message.

GetWriterStatusCount

Returns the number of writers for which there is status.

FreeWriterStatus

Frees system resources allocated during the call to GatherWriterStatus.

GetWriterStatus

Returns the status of the specified writer.

SetBackupSucceeded

Indicates whether the backup of the specified component was successful.

SetBackupOptions

Sets a string of private, or writer-dependent, backup parameters for a writer component.

SetSelectedForRestore

Indicates whether the specified component has been selected for restoration.

SetRestoreOptions

Sets a string of private, or writer-dependent, restore parameters for a writer component.

SetAdditionalRestores

Indicates whether additional restores of the component will follow this restore (that is, full restore followed by log file restores).

SetPreviousBackupStamp

Sets a backup stamp indicating the time of a previous backup against which a differential or incremental backup is to be evaluated.

SaveAsXML

Saves the specified backup component metadata file to the storage media.

BackupComplete

Signals writers that the backup process has completed.

AddAlternativeLocationMapping

Creates an alternate location mapping for the specified file or files.

AddRestoreSubcomponent

Adds a subcomponent to be restored and allows a requester to restore a portion of the entire component.

SetFileRestoreStatus

Requester indicates whether all, some, or none of the files were successfully restored.

AddNewTarget

Adds a new target location to which a file is to be restored.

SetRangesFilePath

Indicates that the ranges file used in a partial file operation has been restored to a new location.

PreRestore

Signals the PreRestore event to the writers.

PostRestore

Signals the PostRestore event to the writers.

SetContext

Sets the context for all subsequent shadow copy-related operations.

StartSnapshotSet

Creates a new, empty shadow copy set.

AddToSnapshotSet

Adds shadow copies to the shadow copy set.

DoSnapshotSet

Commits all shadow copies in this set simultaneously.

DeleteSnapshots

Deletes one or more shadow copies or a shadow copy set.

ImportSnapshots

Imports shadow copies transported from a different machine.

BreakSnapshotSet

Causes the existence of a shadow copy set to be "forgotten" by VSS.

GetSnapshotProperties

Gets the properties of the specified shadow copy.

Query

Queries the list of providers or shadow copies in the system.

IsVolumeSupported

Determines whether the specified provider supports shadow copies for the specified volume.

DisableWriterClasses

Disables the requesting of writer metadata from the specified writer classes.

EnableWriterClasses

Enables the requesting of writer metadata from the specified writer classes.

DisableWriterInstances

Disables the specified writer instances.

ExposeSnapshot

Exposes the specified shadow copy as a drive letter, mounted folder, or file share.

RevertToSnapshot

Reverts a volume to a previous shadow copy.

QueryRevertStatus

Returns an IVssAsync interface pointer that can be used to determine the status of the revert operation.

 

Requirements

Minimum supported clientWindows XP
Minimum supported serverWindows Server 2003
HeaderVsBackup.h (include VsBackup.h, Vss.h, or VsWriter.h)
LibraryVssApi.lib

Send comments about this topic to Microsoft

Build date: 11/12/2009

Tags :


Community Content

Noelle Mallory - MSFT
Differences between XP and 2003

RevertToSnapshot and QueryRevertStatus are not defined on XP, only 2003.

Why were the interfaces changed without releasing a new Interface definition, breaking backwards compatibility?

[Noelle Mallory - MSFT] Please post questions to the MSDN Forums at http://forums.microsoft.com/msdn. You will likely get a quicker response through the forum than through the Community Content.

Tags :

Page view tracker