Click or drag to resize
IVssComponent Interface

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

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

The IVssComponent type exposes the following members.

Properties
  NameDescription
Public propertyAdditionalRestores
The AdditionalRestores is used by a writer during incremental or differential restore operations to determine whether a given component will require additional restore operations to completely retrieve it, but can also be called by a requester.
Public propertyAlternateLocationMappings
A collection of mapping information for the file set's alternate location for file restoration.
Public propertyBackupOptions

The backup options specified to the writer that manages the currently selected component or component set by a requester using SetBackupOptions(Guid, VssComponentType, String, String, String).

Public propertyBackupStamp
The backup stamp string stored by a writer for a given component.
Public propertyBackupSucceeded
The status of a complete attempt at backing up all the files of a selected component or component set as a VssFileRestoreStatus enumeration.
Public propertyComponentName
The logical name of this component.
Public propertyComponentType
The type of this component in terms of the ComponentType enumeration.
Public propertyDifferencedFiles
Information about the file sets (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 propertyDirectedTargets
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 propertyFailure
VSS requesters read this property to retrieve component-level errors reported by writers. VSS writers set this property to report errors at the component level.
Public propertyFileRestoreStatus
The status of a completed attempt to restore all the files of a selected component or component set as a VssFileRestoreStatus enumeration.
Public propertyIsAuthoritativeRestore
Gets a value indicating whether a requester has marked the restore of a component as authoritative for a replicated data store.
Public propertyIsSelectedForRestore
Determines whether the current component has been selected to be restored.
Public propertyLogicalPath
The logical path of this component.
Public propertyNewTargets
The new file restoration locations for the selected component or component set.
Public propertyPartialFiles
Information about any partial files associated with this component.
Public propertyPostRestoreFailureMsg
The failure message generated by a writer while handling the PostRestore event if one was set.
Public propertyPostSnapshotFailureMsg
Gets the PostSnapshot failure message string that a writer has set for a given component.
Public propertyPrepareForBackupFailureMsg
Gets the PrepareForBackup failure message string that a writer has set for a given component.
Public propertyPreRestoreFailureMsg
The failure message generated by a writer while handling the PreRestore event if one was set.
Public propertyPreviousBackupStamp
A previous backup stamp loaded by a requester in the Backup Components Document. The value is used by a writer when deciding if files should participate in differential or incremental backup operation.
Public propertyRestoreName
Obtains the logical name assigned to a component that is being restored.
Public propertyRestoreOptions
The restore options specified to the current writer by a requester using SetRestoreOptions(Guid, VssComponentType, String, String, String).
Public propertyRestoreSubcomponents
The subcomponents associated with this component.
Public propertyRestoreTarget
The restore target (in terms of the VssRestoreTarget enumeration) for the current component. Can only be called during a restore operation.
Public propertyRollForwardRestorePoint
Obtains the restore point for a partial roll-forward operation.
Public propertyRollForwardType
Obtains the roll-forward operation type for a component.
Top
Remarks

IVssComponent objects can be obtained only for those components that have been explicitly added to the Backup Components Document during a backup operation by the AddComponent(Guid, Guid, VssComponentType, String, String) method.

Information about components explicitly added during a restore operation using AddRestoreSubcomponent(Guid, VssComponentType, String, String, String, String) are not available through the IVssComponent interface.

For more information, see the MSDN documentation on the IVssComponent Interface.

See Also