Namespace Alphaleonis.Win32.Vss

Classes

UnsupportedOperatingSystemException

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.

VssBadStateException

Exception class indicating that the vss object referenced was not in a correct state for the requested operation.

VssCannotRevertDiskIdException

Exception indicating that the resynchronization destination contained a volume that was not explicitly included.

VssComponentFailure

Represents a component-level error reported by writers.

VssDeleteSnapshotsFailedException

Exception thrown to indicate that the requested deletion of snapshots did not complete successfully.

VssDiffAreaProperties

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).

VssDifferencedFileInfo

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).

VssDiffVolumeProperties

The VssDiffVolumeProperties structure describes a shadow copy storage area volume.

VssDirectedTargetInfo

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.

VssException

Base class for exceptions indicating an error occuring during a VSS operation.

VssFactoryProvider

Class that provides instances of IVssFactory which in turn is used as the entry point to accessing the various VSS functions.

VssFlushWritesTimeoutException

Exception thrown to indicate The system was unable to flush I/O writes.

VssHoldWritesTimeoutException

Exception thrown to indicate that the system was unable to hold I/O writes.

VssInconsistentSnapshotWriterException

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.

VssInsufficientStorageException

Exception thrown to indicate that the system or provider has insufficient storage space.

VssInvalidXmlDocumentException

Exception thrown to indicate that the XML document is not valid. Check the event log for details.

VssLegacyProviderException

Exception indicating that this version of the hardware provider does not support this operation.

VssMaximumDiffAreaAssociationsReachedException

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.

VssMaximumNumberOfSnapshotsReachedException

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.

VssMaximumNumberOfVolumesReachedException

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.

VssNonRetryableWriterException

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.

VssObjectAlreadyExistsException

Exception thrown to indicate that the requested object was a duplicate.

VssObjectNotFoundException

Exception thrown to indicate that the requested object did not exists.

VssOutOfResourcesWriterException

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.

VssPartialFailureWriterException

Exception indicating the writer is reporting one or more component-level errors. To retrieve the errors, the requester must use the Failure property.

VssPartialFileInfo

Representation of information on a partial file associated with a component.

VssProviderNotRegisteredException

Exception thrown to indicate that the requested identifier does not correspond to a registered provider.

VssProviderProperties

The VssProviderProperties class specifies shadow copy provider properties.

VssProviderVetoException

Exception thrown to indicate an expected provider error. The provider logged the error in the event log.

VssRebootRequiredException

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

VssRestoreSubcomponentInfo

Represents information about a Subcomponent associated with a given component.

VssResyncInProgressException

Exception thrown to indicate that another LUN resynchronization operation is already in progress.

VssRetryableWriterException

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.

VssRevertInProgressException

Exception thrown to indicate that the volume already has a revert in progress.

VssRootAndLogicalPrefixPaths

Contains a normalized local volume path or UNC share path as returned by GetRootAndLogicalPrefixPaths(String, Boolean).

VssSnapshotNotInSetException

Exception thrown to indicate that the specified snapshot specifies a shadow copy that does not exist in the Backup Components Document.

VssSnapshotProperties

The VssSnapshotProperties class contains the properties of a shadow copy or shadow copy set.

VssSnapshotSetInProgressException

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.

VssTimeoutWriterException

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.

VssTransactionFreezeTimeoutException

Exception thrown to indicate that the system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).

VssTransactionThawTimeoutException

Exception thrown to indicate that the system was unable to thaw the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).

VssUnexpectedErrorException

Exception class indicating that an unexpected error occured. The error code is logged in the error log file.

VssUnexpectedProviderErrorException

Exception thrown to indicate that the provider returned an unexpected error code. This can be a transient problem.

VssUnexpectedWriterErrorException

Exception thrown to indicate that an unexpected error occurred during communication with writers.

VssUnselectedVolumeException

Exception indicating that the resynchronization destination contained a volume that was not explicitly included.

VssUnsupportedContextException

Exception thrown to indicate that the operation is not supported under the current context.

VssWMDependency

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.

VssWMFileDescriptor

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).

VssWMRestoreMethod

Represents information about how a writer wants its data to be restored.

VssVolumeInUseException

Exception indicating that the volume was in use and could not be locked.

VssVolumeNotSupportedByProviderException

Exception thrown to indicate that the volume is not supported by the specified provider.

VssVolumeNotSupportedException

Exception thrown to indicate that the volume does not support the requested operation, or that no provider supports it.

VssVolumeProperties

The VssVolumeProperties class contains the properties of a shadow copy source volume.

VssVolumeProtectionInfo

Contains information about a volume's shadow copy protection level.

VssWriterException

Base class for exceptions thrown to indicate errors reported by VSS writers.

VssWriterInfrastructureException

Exception thrown to indicate that the writer infrastructure is not operating properly.

VssWriterNotRespondingException

Exception indicating that the writer is not responding.

VssWriterStatusInfo

Represenation of the status for a specific writer.

VssWriterStatusNotAvailableException

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

IVssAssemblyResolver

An interface providing methods for IVssFactoryProvider to load the platform specific assembly required for instantiating IVssFactory.

IVssAsyncResult

Represents the status of an asynchronous operation performed by the VSS framework.

IVssBackupComponents

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

IVssComponent

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

IVssDifferentialSoftwareSnapshotManagement

The IVssDifferentialSoftwareSnapshotManagement interface contains methods that allow applications to query and manage shadow copy storage areas generated by the system shadow copy provider.

IVssExamineWriterMetadata

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.

IVssFactory

IVssFactory provides an interface to the global methods of the VSS API compiled for a specific platform.

IVssFactoryProvider

Interface for a provider that provides the correct implementation of IVssFactory which is used as the entry point to accessing the various VSS functions.

IVssInfoProvider

Provides access to global methods of the Win32 VSS API that allow querying for specific information.

IVssSnapshotManagement

The IVssSnapshotManagement interface provides a method that returns an interface to further configure a shadow copy provider.

IVssWMComponent

IVssWMComponent is a class that allows access to component information stored in a Writer Metadata Document. Instances of IVssWMComponent are obtained by enumerating .

IVssWriterComponents

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.

Enums

VssBackupSchema

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.

VssBackupType

The VssBackupType enumeration indicates the type of backup to be performed using VSS writer/requester coordination.

VssComponentFlags

The VssComponentFlags enumeration is used by writers to indicate support for auto-recovery.

VssComponentType

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.

VssError

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

VssFileRestoreStatus

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.

VssFileSpecificationBackupType

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

VssHardwareOptions

Defines shadow copy LUN flags.

VssObjectType

The VssObjectType enumeration is used by requesters to identify an object as a shadow copy set, shadow copy, or provider.

VssProtectionFault

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).

VssProtectionLevel

Defines the set of volume shadow copy protection levels.

VssProviderType

The VssProviderType enumeration specifies the provider type.

VssRecoveryOptions

Used by a requester to specify how a resynchronization operation is to be performed.

VssRestoreMethod

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.

VssRestoreTarget

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).

VssRestoreType

The VssRestoreType enumeration is used by a requester to indicate the type of restore operation it is about to perform.

VssRollForwardType

The VssRollForwardType enumeration is used by a requester to indicate the type of roll-forward operation it is about to perform.

VssSnapshotCompatibility

The VssSnapshotCompatibility enumeration indicates which volume control or file I/O operations are disabled for the volume that has been shadow copied.

VssSnapshotContext

The VssSnapshotContext enumeration enables a requester using SetContext(VssSnapshotContext) 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 bit mask that contains a valid combination of VssVolumeSnapshotAttributes and VssSnapshotContext enumeration values.

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.

VssWriterRestore

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.

VssWriterState

The VssWriterState enumeration indicates the current state of the writer.