Click or drag to resize

Alphaleonis.Win32.Vss Namespace

This documentation describes the AlphaVSS managed interface to the VSS API.

AlphaVSS replicates the unmanaged VSS API fairly closely, and the official documentation from Microsoft should be consulted for information about using the Windows volume shadow copy service, and should also serve as a good documentation for this library. The documentation provided here is provided for convenience only, and the official documentation on the MSDN homepage should always be consulted for the latest and most accurate information about the inner workings of the Volume Shadow Copy services.

Classes
  ClassDescription
Public classOperatingSystemInfo
Static class providing access to information about the operating system under which the assembly is executing.
Public classUnsupportedOperatingSystemException
Exception indicating that the requested method is not supported on the current operating system, or the loaded assembly is targeted for a different operating system than the one on which it is running.
Public classVssBadStateException
Exception class indicating that the vss object referenced was not in a correct state for the requested operation.
Public classVssCannotRevertDiskIdException
Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
Public classVssComponentFailure
Represents a component-level error reported by writers.
Public classVssDeleteSnapshotsFailedException
Exception thrown to indicate that the requested deletion of snapshots did not complete successfully.
Public classVssDiffAreaProperties
The VssDiffAreaProperties structure describes associations between volumes containing the original file data and volumes containing the shadow copy storage area (also known as the diff area).
Public classVssDifferencedFileInfo
Information about a file set (a specified file or files) to participate in an incremental or differential backup or restore as a differenced file, that is, backup and restores associated with it are to be implemented as if entire files are copied to and from backup media (as opposed to using partial files).
Public classVssDiffVolumeProperties
The VssDiffVolumeProperties structure describes a shadow copy storage area volume.
Public classVssDirectedTargetInfo
Represents information stored by a writer, at backup time, to the Backup Components Document to indicate that when a file is to be restored, it (the source file) should be remapped. The file may be restored to a new restore target and/or ranges of its data restored to different locations with the restore target.
Public classVssException
Base class for exceptions indicating an error occuring during a VSS operation.
Public classVssFlushWritesTimeoutException
Exception thrown to indicate The system was unable to flush I/O writes.
Public classVssHoldWritesTimeoutException
Exception thrown to indicate that the system was unable to hold I/O writes.
Public classVssInconsistentSnapshotWriterException
Exception indicating that the the shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.
Public classVssInsufficientStorageException
Exception thrown to indicate that the system or provider has insufficient storage space.
Public classVssInvalidXmlDocumentException
Exception thrown to indicate that the XML document is not valid. Check the event log for details.
Public classVssLegacyProviderException
Exception indicating that this version of the hardware provider does not support this operation.
Public classVssMaximumDiffAreaAssociationsReachedException
Exception indicating that the maximum number of shadow copy storage areas has been added to the shadow copy source volume. The specified shadow copy storage volume was not associated with the specified shadow copy source volume.
Public classVssMaximumNumberOfSnapshotsReachedException
Exception thrown to indicate that the maximum number of volumes has been added to the shadow copy set. The specified volume was not added to the shadow copy set.
Public classVssMaximumNumberOfVolumesReachedException
Exception thrown to indicate that the volume has been added to the maximum number of shadow copy sets. The specified volume was not added to the shadow copy set.
Public classVssNonRetryableWriterException
Exception indicating that the writer operation failed because of an error that might recur if another shadow copy is created. For more information, see Event and Error Handling Under VSS.
Public classVssObjectAlreadyExistsException
Exception thrown to indicate that the requested object was a duplicate.
Public classVssObjectNotFoundException
Exception thrown to indicate that the requested object did not exists.
Public classVssOutOfResourcesWriterException
Exception indicating that the writer ran out of memory or other system resources. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
Public classVssPartialFailureWriterException
Exception indicating the writer is reporting one or more component-level errors. To retrieve the errors, the requester must use the Failure property.
Public classVssPartialFileInfo
Representation of information on a partial file associated with a component.
Public classVssProviderNotRegisteredException
Exception thrown to indicate that the requested identifier does not correspond to a registered provider.
Public classVssProviderProperties
The VssProviderProperties class specifies shadow copy provider properties.
Public classVssProviderVetoException
Exception thrown to indicate an expected provider error. The provider logged the error in the event log.
Public classVssRebootRequiredException

Exception thrown to indicate that the provider encountered an error that requires the user to restart the computer.

Public classVssRestoreSubcomponentInfo
Represents information about a Subcomponent associated with a given component.
Public classVssResyncInProgressException
Exception thrown to indicate that another LUN resynchronization operation is already in progress.
Public classVssRetryableWriterException
Exception indicating that the writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation process was restarted. The recommended way to handle this error is to wait ten minutes and then repeat the operation, up to three times.
Public classVssRevertInProgressException
Exception thrown to indicate that the volume already has a revert in progress.
Public classVssRootAndLogicalPrefixPaths
Contains a normalized local volume path or UNC share path as returned by GetRootAndLogicalPrefixPaths(String, Boolean).
Public classVssSnapshotNotInSetException
Exception thrown to indicate that the specified snapshot specifies a shadow copy that does not exist in the Backup Components Document.
Public classVssSnapshotProperties
The VssSnapshotProperties class contains the properties of a shadow copy or shadow copy set.
Public classVssSnapshotSetInProgressException
Exception indicating that the creation of a shadow copy is in progress, and only one shadow copy creation operation can be in progress at one time. Either wait to try again or return with a failure.
Public classVssTimeoutWriterException
Exception indicating that the writer operation failed because of a time-out between the Freeze and Thaw events. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
Public classVssTransactionFreezeTimeoutException
Exception thrown to indicate that the system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
Public classVssTransactionThawTimeoutException
Exception thrown to indicate that the system was unable to thaw the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
Public classVssUnexpectedErrorException
Exception class indicating that an unexpected error occured. The error code is logged in the error log file.
Public classVssUnexpectedProviderErrorException
Exception thrown to indicate that the provider returned an unexpected error code. This can be a transient problem.
Public classVssUnexpectedWriterErrorException
Exception thrown to indicate that an unexpected error occurred during communication with writers.
Public classVssUnselectedVolumeException
Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
Public classVssUnsupportedContextException
Exception thrown to indicate that the operation is not supported under the current context.
Public classVssUtils
The VssUtils class is a static utility class for accessing the platform specific instances of the various VSS interfaces in a platform-independent manner.
Public classVssWMDependency
VssWMDependency is used to determine the writer ID, logical path, and component name of components that must be restored or backed up along with the target component.
Public classVssWMFileDescriptor
The VssWMFileDescriptor class is returned to a calling application by a number of query methods. It provides detailed information about a file or set of files (a file set).
Public classVssWMRestoreMethod
Represents information about how a writer wants its data to be restored.
Public classVssVolumeInUseException
Exception indicating that the volume was in use and could not be locked.
Public classVssVolumeNotSupportedByProviderException
Exception thrown to indicate that the volume is not supported by the specified provider.
Public classVssVolumeNotSupportedException
Exception thrown to indicate that the volume does not support the requested operation, or that no provider supports it.
Public classVssVolumeProperties
The VssVolumeProperties class contains the properties of a shadow copy source volume.
Public classVssVolumeProtectionInfo
Contains information about a volume's shadow copy protection level.
Public classVssWriterException
Base class for exceptions thrown to indicate errors reported by VSS writers.
Public classVssWriterInfrastructureException
Exception thrown to indicate that the writer infrastructure is not operating properly.
Public classVssWriterNotRespondingException
Exception indicating that the writer is not responding.
Public classVssWriterStatusInfo
Represenation of the status for a specific writer.
Public classVssWriterStatusNotAvailableException
Exception indicating that the writer status is not available for one or more writers. A writer may have reached the maximum number of available backup and restore sessions.
Interfaces
  InterfaceDescription
Public interfaceIVssAsyncResult
Represents the status of an asynchronous operation performed by the VSS framework.
Public interfaceIVssBackupComponents
The IVssBackupComponents class is used by a requester to poll writers about file status and to run backup/restore operations.
Public interfaceIVssComponent

Interface containing methods for examining and modifying information about components contained in a requester's Backup Components Document.

Public interfaceIVssDifferentialSoftwareSnapshotManagement
The IVssDifferentialSoftwareSnapshotManagement interface contains methods that allow applications to query and manage shadow copy storage areas generated by the system shadow copy provider.
Public interfaceIVssExamineWriterMetadata
A class that allows a requester to examine the metadata of a specific writer instance. This metadata may come from a currently executing (live) writer, or it may have been stored as an XML document.
Public interfaceIVssImplementation
IVssImplementation provides an interface to the global methods of the VSS API compiled for a specific platform.
Public interfaceIVssSnapshotManagement
The IVssSnapshotManagement interface provides a method that returns an interface to further configure a shadow copy provider.
Public interfaceIVssWMComponent
IVssWMComponent is a class that allows access to component information stored in a Writer Metadata Document. Instances of IVssWMComponent are obtained by enumerating .
Public interfaceIVssWriterComponents
The IVssWriterComponents interface contains methods used to obtain and modify component information (in the form of IVssComponent instances) associated with a given writer but stored in a requester's Backup Components Document.
Enumerations
  EnumerationDescription
Public enumerationOSVersionName
Enumeration used to discriminate between the named windows versions.
Public enumerationProcessorArchitecture
Enumeration used by OperatingSystemInfo to indicate the current processor architecture for which the operating system is targeted and running.
Public enumerationVssBackupSchema
The VssBackupSchema enumeration is used by a writer to indicate the types of backup operations it can participate in. The supported kinds of backup are expressed as a bit mask (or bitwise OR) of VssBackupSchema values.
Public enumerationVssBackupType
The VssBackupType enumeration indicates the type of backup to be performed using VSS writer/requester coordination.
Public enumerationVssComponentFlags
The VssComponentFlags enumeration is used by writers to indicate support for auto-recovery.
Public enumerationVssComponentType
The VssComponentType enumeration is used by both the requester and the writer to specify the type of component being used with a shadow copy backup operation.
Public enumerationVssError

The VssError enumeration represents error- and success codes that may be returned by some Vss methods.

Public enumerationVssFileRestoreStatus
The VssFileRestoreStatus enumeration defines the set of statuses of a file restore operation performed on the files managed by a selected component or component set.
Public enumerationVssFileSpecificationBackupType

The VssFileSpecificationBackupType enumeration is used by writers to indicate their support of certain backup operations—such as incremental or differential backup—on the basis of file sets (a specified file or files).

File sets stored in the Writer Metadata Document are tagged with a bit mask (or bitwise OR) of VssFileSpecificationBackupType values indicating the following:

  • Whether the writer and the requester have to evaluate a given file set for participation in the specified type of backup operations
  • Whether backing up the specified file will require a shadow copy

Public enumerationVssHardwareOptions
Defines shadow copy LUN flags.
Public enumerationVssObjectType
The VssObjectType enumeration is used by requesters to identify an object as a shadow copy set, shadow copy, or provider.
Public enumerationVssProtectionFault
Defines the set of shadow copy protection faults. A shadow copy protection fault occurs when the VSS service is unable to perform a copy-on- write operation to the shadow copy storage area (also called the diff area).
Public enumerationVssProtectionLevel
Defines the set of volume shadow copy protection levels.
Public enumerationVssProviderType
The VssProviderType enumeration specifies the provider type.
Public enumerationVssRecoveryOptions
Used by a requester to specify how a resynchronization operation is to be performed.
Public enumerationVssRestoreMethod
This enumeration is used by a writer at backup time to specify through its Writer Metadata Document the default file restore method to be used with all the files in all the components it manages.
Public enumerationVssRestoreTarget

The VssRestoreTarget enumeration is used by a writer at restore time to indicate how all the files included in a selected component, and all the files in any component set it defines, are to be restored.

Setting a restore target modifies or overrides the restore method set during backup (see VssRestoreMethod).

Public enumerationVssRestoreType
The VssRestoreType enumeration is used by a requester to indicate the type of restore operation it is about to perform.
Public enumerationVssRollForwardType
The VssRollForwardType enumeration is used by a requester to indicate the type of roll-forward operation it is about to perform.
Public enumerationVssSnapshotCompatibility
The VssSnapshotCompatibility enumeration indicates which volume control or file I/O operations are disabled for the volume that has been shadow copied.
Public enumerationVssSnapshotContext
The VssSnapshotContext enumeration enables a requester using SetContext Overload to specify how a shadow copy is to be created, queried, or deleted and the degree of writer involvement. IVssBackupComponents::SetContext" method) may be modified by a bitmask that contains a valid combination of VssVolumeSnapshotAttributes and VssSnapshotContext enumeration values.
Public enumerationVssSnapshotState
The VssSnapshotState enumeration is returned by a provider to specify the state of a given shadow copy operation.
Public enumerationVssSourceType
The VssSourceType enumeration specifies the type of data that a writer manages.
Public enumerationVssUsageType
The VssUsageType enumeration specifies how the host system uses the data managed by a writer involved in a VSS operation.
Public enumerationVssVolumeSnapshotAttributes
Allows additional attributes to be specified for a shadow copy. The context of a shadow copy (as set by the SetContext method in IVssBackupComponents method) may be modified by a bitmask that contains a valid combination of VssVolumeSnapshotAttributes and VssSnapshotContext enumeration values.
Public enumerationVssWriterRestore
The VssWriterRestore enumeration is used by a writer to indicate to a requester the conditions under which it will handle events generated during a restore operation.
Public enumerationVssWriterState
The VssWriterState enumeration indicates the current state of the writer.