| IVssBackupComponents Methods |
The IVssBackupComponents type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AbortBackup | 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. |
| AddAlternativeLocationMapping |
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.
|
| AddComponent |
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.
|
| AddNewTarget |
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.
|
| AddRestoreSubcomponent |
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.
|
| AddSnapshotToRecoverySet |
Specifies the volumes to be included in a LUN resynchronization operation. This method is supported only on Windows server operating systems.
|
| AddToSnapshotSet(String) |
The AddToSnapshotSet(String) method adds an original volume to the shadow copy set using the default provider.
|
| AddToSnapshotSet(String, Guid) |
The AddToSnapshotSet(String, Guid) method adds an original volume to the shadow copy set.
|
| BackupComplete |
This method causes VSS to generate a BackupComplete event, which signals writers that the backup
process has completed.
|
| BeginBackupComplete |
This method asynchronously causes VSS to generate a BackupComplete event, which signals writers that the backup
process has completed.
|
| BeginBreakSnapshotSet |
Begins an asynchronous operation to break a shadow copy set according to requester-specified options.
|
| BeginDoSnapshotSet |
Commits all shadow copies in this set simultaneously as an asynchronous operation.
|
| BeginGatherWriterMetadata |
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.
|
| BeginGatherWriterStatus |
The BeginGatherWriterStatus(AsyncCallback, Object) method asynchronously prompts each writer to send a status message.
|
| BeginImportSnapshots |
The BeginImportSnapshots(AsyncCallback, Object) method asynchronously imports shadow copies transported from a different machine.
|
| BeginPostRestore |
The BeginPostRestore(AsyncCallback, Object) method will asynchronously cause VSS to generate a PostRestore event, signaling writers that the current
restore operation has finished.
|
| BeginPrepareForBackup |
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.
|
| BeginPreRestore |
The BeginPreRestore(AsyncCallback, Object) method will asynchronously cause VSS to generate a PreRestore event, signaling writers to prepare for a
coming restore operation.
|
| BeginQueryRevertStatus |
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.
|
| BeginRecoverSet |
Begins an asynchronous operation that initiates a LUN resynchronization operation. This method is supported only on Windows server operating systems.
|
| BreakSnapshotSet(Guid) |
The BreakSnapshotSet method causes the existence of a shadow copy set to be "forgotten" by VSS.
|
| BreakSnapshotSet(Guid, VssHardwareOptions) |
Breaks a shadow copy set according to requester-specified options.
|
| DeleteSnapshot |
The DeleteSnapshot method deletes a shadow copy..
|
| DeleteSnapshotSet |
The DeleteSnapshotSet method deletes a shadow copy set including any shadow copies in that set.
|
| DisableWriterClasses |
This method prevents a specific class of writers from receiving any events.
|
| DisableWriterInstances |
This method disables a specified writer instance or instances.
|
| DoSnapshotSet |
Commits all shadow copies in this set simultaneously.
|
| EnableWriterClasses |
The EnableWriterClasses method enables the specified writers to receive all events.
|
| EndBackupComplete |
Waits for a pending asynchronous operation to complete.
|
| EndBreakSnapshotSet |
Waits for an asynchronous operation to complete.
|
| EndDoSnapshotSet |
Waits for a pending asynchronous operation to complete.
|
| EndGatherWriterMetadata |
Waits for a pending asynchronous operation to complete.
|
| EndGatherWriterStatus |
Waits for a pending asynchronous operation to complete.
|
| EndImportSnapshots |
Waits for a pending asynchronous operation to complete.
|
| EndPostRestore |
Waits for a pending asynchronous operation to complete.
|
| EndPrepareForBackup |
Waits for a pending asynchronous operation to complete.
|
| EndPreRestore |
Waits for a pending asynchronous operation to complete.
|
| EndQueryRevertStatus |
Waits for a pending asynchronous operation to complete.
|
| EndRecoverSet |
Waits for a pending asynchronous operation to complete.
|
| ExposeSnapshot |
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.
|
| FreeWriterMetadata |
The FreeWriterMetadata method frees system resources allocated when GatherWriterMetadata was called.
|
| FreeWriterStatus |
The FreeWriterStatus method frees system resources allocated during the call to GatherWriterStatus.
|
| GatherWriterMetadata |
The GatherWriterMetadata method prompts each writer to send the metadata they have collected. The method will generate an Identify event to communicate with writers.
|
| GatherWriterStatus |
The GatherWriterStatus method prompts each writer to send a status message.
|
| GetSessionId |
Gets the requester's session identifier.
|
| GetSnapshotProperties |
The GetSnapshotProperties(Guid) method gets the properties of the specified shadow copy.
|
| ImportSnapshots |
The ImportSnapshots method imports shadow copies transported from a different machine.
|
| InitializeForBackup |
The InitializeForBackup(String) method initializes the backup components metadata in preparation for backup.
|
| InitializeForRestore |
The InitializeForRestore(String) method initializes the IIVssBackupComponents interface in preparation for a restore operation.
|
| IsVolumeSupported(String) |
The IsVolumeSupported method determines whether any provider supports shadow copies on the specified volume.
|
| IsVolumeSupported(String, Guid) |
The IsVolumeSupported method determines whether the specified provider supports shadow copies on the specified volume.
|
| PostRestore |
The PostRestore method will cause VSS to generate a PostRestore event, signaling writers that the current
restore operation has finished.
|
| PrepareForBackup |
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.
|
| PreRestore |
The PreRestore method will cause VSS to generate a PreRestore event, signaling writers to prepare for a
coming restore operation.
|
| QueryProviders |
The QueryProviders method queries providers on the system.
The method can be called only during backup operations.
|
| QuerySnapshots |
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.
|
| RecoverSet |
Initiates a LUN resynchronization operation. This method is supported only on Windows server operating systems.
|
| RevertToSnapshot |
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.
|
| SaveAsXml |
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.
|
| SetAdditionalRestores |
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.
|
| SetAuthoritativeRestore |
Marks the restore of a component as authoritative for a replicated data store.
|
| SetBackupOptions |
Sets a string of private, or writer-dependent, backup parameters for a component.
|
| SetBackupState |
Defines an overall configuration for a backup operation.
|
| SetBackupSucceeded |
Indicates whether the backup of the specified component of a specific writer was successful.
|
| SetContext(VssSnapshotContext) |
Sets the context for subsequent shadow copy-related operations.
|
| SetContext(VssVolumeSnapshotAttributes) |
Sets the context for subsequent shadow copy-related operations.
|
| SetFileRestoreStatus |
Indicates whether some, all, or no files were successfully restored.
|
| SetPreviousBackupStamp | 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. |
| SetRangesFilePath |
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.
|
| SetRestoreName |
Assigns a new logical name to a component that is being restored.
|
| SetRestoreOptions |
Sets a string of private, or writer-dependent, restore parameters for a writer component.
|
| SetRestoreState |
Defines an overall configuration for a restore operation.
|
| SetRollForward |
Sets the roll-forward operation type for a component and specifies the restore point for a partial roll-forward operation.
|
| SetSelectedForRestore(Guid, VssComponentType, String, String, Boolean) |
Indicates whether the specified selectable component is selected for restoration.
|
| SetSelectedForRestore(Guid, VssComponentType, String, String, Boolean, Guid) |
Indicates whether the specified selectable component is selected for restoration to a specified writer instance.
|
| StartSnapshotSet |
Creates a new, empty shadow copy set.
|
| UnexposeSnapshot |
Unexposes a shadow copy either by deleting the file share or by removing the drive letter or mount point.
|
See Also