Export (0) Print
Expand All

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.

Members

The IVssBackupComponents interface inherits from the IUnknown interface. IVssBackupComponents also has these types of members:

Methods

The IVssBackupComponents interface has these methods.

MethodDescription
AbortBackup

Terminates the current backup.

AddAlternativeLocationMapping

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

AddComponent

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

AddNewTarget

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

AddRestoreSubcomponent

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

AddToSnapshotSet

Adds shadow copies to the shadow copy set.

BackupComplete

Signals writers that the backup process has completed.

BreakSnapshotSet

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

DeleteSnapshots

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

DisableWriterClasses

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

DisableWriterInstances

Disables the specified writer instances.

DoSnapshotSet

Commits all shadow copies in this set simultaneously.

EnableWriterClasses

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

ExposeSnapshot

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

FreeWriterMetadata

Frees system resources allocated when GatherWriterMetadata is called.

FreeWriterStatus

Frees system resources allocated during the call to GatherWriterStatus.

GatherWriterMetadata

Prompts each writer to send the metadata it has collected.

GatherWriterStatus

Prompts each writer to send a status message.

GetSnapshotProperties

Gets the properties of the specified shadow copy.

GetWriterComponents

Obtains a specific writer component.

GetWriterComponentsCount

Gets the number of writer components.

GetWriterMetadata

Returns writer metadata for a specific writer.

GetWriterMetadataCount

Returns the number of writers for which there is metadata.

GetWriterStatus

Returns the status of the specified writer.

GetWriterStatusCount

Returns the number of writers for which there is status.

ImportSnapshots

Imports shadow copies transported from a different machine.

InitializeForBackup

Initializes the backup components metadata file in preparation for backup.

InitializeForRestore

Initializes the IVssBackupComponents interface in preparation for a restore operation.

IsVolumeSupported

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

PostRestore

Signals the PostRestore event to the writers.

PrepareForBackup

Signals all writers that a backup is about to occur.

PreRestore

Signals the PreRestore event to the writers.

Query

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

QueryRevertStatus

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

RevertToSnapshot

Reverts a volume to a previous shadow copy.

SaveAsXML

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

SetAdditionalRestores

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

SetBackupOptions

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

SetBackupState

Defines an overall configuration for a backup operation.

SetBackupSucceeded

Indicates whether the backup of the specified component was successful.

SetContext

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

SetFileRestoreStatus

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

SetPreviousBackupStamp

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

SetRangesFilePath

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

SetRestoreOptions

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

SetRestoreState

Sets how a restore will be processed.

SetSelectedForRestore

Indicates whether the specified component has been selected for restoration.

StartSnapshotSet

Creates a new, empty shadow copy set.

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

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

Library

VssApi.lib

 

 

Community Additions

ADD
Show:
© 2014 Microsoft