Click or drag to resize
IVssBackupComponents Interface
The IVssBackupComponents class is used by a requester to poll writers about file status and to run backup/restore operations.

Namespace: Alphaleonis.Win32.Vss
Assembly: AlphaVSS.Common (in AlphaVSS.Common.dll) Version: 1.3.0.0 (1.3.0.0)
Syntax
public interface IVssBackupComponents : IDisposable

The IVssBackupComponents type exposes the following members.

Methods
  NameDescription
Public methodAbortBackup

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 StartSnapshotSet and before DoSnapshotSetreturns.

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

Public methodAddAlternativeLocationMapping
The AddAlternativeLocationMapping method is used by a requester to indicate that an alternate location mapping was used to restore all the members of a file set in a given component.
Public methodAddComponent
The AddComponent method is used to explicitly add to the backup set in the Backup Components Document all required components (nonselectable for backup components without a selectable for backup ancestor), and such optional (selectable for backup) components as the requester considers necessary. Members of component sets (components with a selectable for backup ancestor) are implicitly included in the backup set, but are not explicitly added to the Backup Components Document.
Public methodAddNewTarget
The AddNewTarget method is used by a requester during a restore operation to indicate that the backup application plans to restore files to a new location.
Public methodAddRestoreSubcomponent
The AddRestoreSubcomponent method indicates that a Subcomponent member of a component set, which had been marked as nonselectable for backup but is marked selectable for restore, is to be restored irrespective of whether any other member of the component set will be restored.
Public methodAddSnapshotToRecoverySet
Specifies the volumes to be included in a LUN resynchronization operation. This method is supported only on Windows server operating systems.
Public methodAddToSnapshotSet(String)
The AddToSnapshotSet(String) method adds an original volume to the shadow copy set using the default provider.
Public methodAddToSnapshotSet(String, Guid)
The AddToSnapshotSet(String, Guid) method adds an original volume to the shadow copy set.
Public methodBackupComplete
This method causes VSS to generate a BackupComplete event, which signals writers that the backup process has completed.
Public methodBeginBackupComplete
This method asynchronously causes VSS to generate a BackupComplete event, which signals writers that the backup process has completed.
Public methodBeginBreakSnapshotSet
Begins an asynchronous operation to break a shadow copy set according to requester-specified options.
Public methodBeginDoSnapshotSet
Commits all shadow copies in this set simultaneously as an asynchronous operation.
Public methodBeginGatherWriterMetadata
The BeginGatherWriterMetadata(AsyncCallback, Object) method asynchronously prompts each writer to send the metadata they have collected. The method will generate an Identify event to communicate with writers.
Public methodBeginGatherWriterStatus
The BeginGatherWriterStatus(AsyncCallback, Object) method asynchronously prompts each writer to send a status message.
Public methodBeginImportSnapshots
The BeginImportSnapshots(AsyncCallback, Object) method asynchronously imports shadow copies transported from a different machine.
Public methodBeginPostRestore
The BeginPostRestore(AsyncCallback, Object) method will asynchronously cause VSS to generate a PostRestore event, signaling writers that the current restore operation has finished.
Public methodBeginPrepareForBackup
The BeginPrepareForBackup(AsyncCallback, Object) method will asynchronously cause VSS to generate a PrepareForBackup event, signaling writers to prepare for an upcoming backup operation. This makes a requester's Backup Components Document available to writers.
Public methodBeginPreRestore
The BeginPreRestore(AsyncCallback, Object) method will asynchronously cause VSS to generate a PreRestore event, signaling writers to prepare for a coming restore operation.
Public methodBeginQueryRevertStatus
The BeginQueryRevertStatus(String, AsyncCallback, Object) method begins an asynchronous operation to determine the status of the revert operation. The returned IVssAsyncResult can be used to determine the outcome of the operation.
Public methodBeginRecoverSet
Begins an asynchronous operation that initiates a LUN resynchronization operation. This method is supported only on Windows server operating systems.
Public methodBreakSnapshotSet(Guid)
The BreakSnapshotSet method causes the existence of a shadow copy set to be "forgotten" by VSS.
Public methodBreakSnapshotSet(Guid, VssHardwareOptions)
Breaks a shadow copy set according to requester-specified options.
Public methodDeleteSnapshot
The DeleteSnapshot method deletes a shadow copy..
Public methodDeleteSnapshotSet
The DeleteSnapshotSet method deletes a shadow copy set including any shadow copies in that set.
Public methodDisableWriterClasses
This method prevents a specific class of writers from receiving any events.
Public methodDisableWriterInstances
This method disables a specified writer instance or instances.
Public methodDoSnapshotSet
Commits all shadow copies in this set simultaneously.
Public methodEnableWriterClasses
The EnableWriterClasses method enables the specified writers to receive all events.
Public methodEndBackupComplete
Waits for a pending asynchronous operation to complete.
Public methodEndBreakSnapshotSet
Waits for an asynchronous operation to complete.
Public methodEndDoSnapshotSet
Waits for a pending asynchronous operation to complete.
Public methodEndGatherWriterMetadata
Waits for a pending asynchronous operation to complete.
Public methodEndGatherWriterStatus
Waits for a pending asynchronous operation to complete.
Public methodEndImportSnapshots
Waits for a pending asynchronous operation to complete.
Public methodEndPostRestore
Waits for a pending asynchronous operation to complete.
Public methodEndPrepareForBackup
Waits for a pending asynchronous operation to complete.
Public methodEndPreRestore
Waits for a pending asynchronous operation to complete.
Public methodEndQueryRevertStatus
Waits for a pending asynchronous operation to complete.
Public methodEndRecoverSet
Waits for a pending asynchronous operation to complete.
Public methodExposeSnapshot
The ExposeSnapshot method exposes a shadow copy either by mounting it as a device on a drive letter or mount point, or as a file share.
Public methodFreeWriterMetadata
The FreeWriterMetadata method frees system resources allocated when GatherWriterMetadata was called.
Public methodFreeWriterStatus
The FreeWriterStatus method frees system resources allocated during the call to GatherWriterStatus.
Public methodGatherWriterMetadata
The GatherWriterMetadata method prompts each writer to send the metadata they have collected. The method will generate an Identify event to communicate with writers.
Public methodGatherWriterStatus
Public methodGetSessionId
Gets the requester's session identifier.
Public methodGetSnapshotProperties
The GetSnapshotProperties(Guid) method gets the properties of the specified shadow copy.
Public methodImportSnapshots
The ImportSnapshots method imports shadow copies transported from a different machine.
Public methodInitializeForBackup
The InitializeForBackup(String) method initializes the backup components metadata in preparation for backup.
Public methodInitializeForRestore
The InitializeForRestore(String) method initializes the IIVssBackupComponents interface in preparation for a restore operation.
Public methodIsVolumeSupported(String)
The IsVolumeSupported method determines whether any provider supports shadow copies on the specified volume.
Public methodIsVolumeSupported(String, Guid)
The IsVolumeSupported method determines whether the specified provider supports shadow copies on the specified volume.
Public methodPostRestore
The PostRestore method will cause VSS to generate a PostRestore event, signaling writers that the current restore operation has finished.
Public methodPrepareForBackup
The PrepareForBackup method will cause VSS to generate a PrepareForBackup event, signaling writers to prepare for an upcoming backup operation. This makes a requester's Backup Components Document available to writers.
Public methodPreRestore
The PreRestore method will cause VSS to generate a PreRestore event, signaling writers to prepare for a coming restore operation.
Public methodQueryProviders
The QueryProviders method queries providers on the system. The method can be called only during backup operations.
Public methodQuerySnapshots
The QuerySnapshots method queries the completed shadow copies in the system that reside in the current context. The method can be called only during backup operations.
Public methodRecoverSet
Initiates a LUN resynchronization operation. This method is supported only on Windows server operating systems.
Public methodRevertToSnapshot
The RevertToSnapshot(Guid, Boolean) method reverts a volume to a previous shadow copy. Only shadow copies created with persistent contexts (AppRollback, ClientAccessible, ClientAccessibleWriters or NasRollback) are supported.
Public methodSaveAsXml
The SaveAsXml method saves the Backup Components Document containing a requester's state information to a specified string. This XML document, which contains the Backup Components Document, should always be securely saved as part of a backup operation.
Public methodSetAdditionalRestores
The SetAdditionalRestores method is used by a requester during incremental or differential restore operations to indicate to writers that a given component will require additional restore operations to completely retrieve it.
Public methodSetAuthoritativeRestore
Marks the restore of a component as authoritative for a replicated data store.
Public methodSetBackupOptions
Sets a string of private, or writer-dependent, backup parameters for a component.
Public methodSetBackupState
Defines an overall configuration for a backup operation.
Public methodSetBackupSucceeded
Indicates whether the backup of the specified component of a specific writer was successful.
Public methodSetContext(VssSnapshotContext)
Sets the context for subsequent shadow copy-related operations.
Public methodSetContext(VssVolumeSnapshotAttributes)
Sets the context for subsequent shadow copy-related operations.
Public methodSetFileRestoreStatus
Indicates whether some, all, or no files were successfully restored.
Public methodSetPreviousBackupStamp

Sets the backup stamp of an earlier backup operation, upon which a differential or incremental backup operation will be based.

The method can be called only during a backup operation.

Public methodSetRangesFilePath
This method is used when a partial file operation requires a ranges file, and that file has been restored to a location other than its original one.
Public methodSetRestoreName
Assigns a new logical name to a component that is being restored.
Public methodSetRestoreOptions
Sets a string of private, or writer-dependent, restore parameters for a writer component.
Public methodSetRestoreState
Defines an overall configuration for a restore operation.
Public methodSetRollForward
Sets the roll-forward operation type for a component and specifies the restore point for a partial roll-forward operation.
Public methodSetSelectedForRestore(Guid, VssComponentType, String, String, Boolean)
Indicates whether the specified selectable component is selected for restoration.
Public methodSetSelectedForRestore(Guid, VssComponentType, String, String, Boolean, Guid)
Indicates whether the specified selectable component is selected for restoration to a specified writer instance.
Public methodStartSnapshotSet
Creates a new, empty shadow copy set.
Public methodUnexposeSnapshot
Unexposes a shadow copy either by deleting the file share or by removing the drive letter or mount point.
Top
Properties
  NameDescription
Public propertyWriterComponents
A read-only list containing information about the components of each writer that has been stored in a requester's Backup Components Document.
Public propertyWriterMetadata
A read-only list containing metadata for the writers running on the systsem.
Public propertyWriterStatus
A read-only list containing the status of the writers.
Top
Remarks

A 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 Dispose(). A 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.

For information on how to retrieve an instance of IVssBackupComponents for the current operating system, see VssUtils and IVssImplementation.

See Also