Export (0) Print
Expand All

IVssComponent interface

The IVssComponent interface is a C++ (not COM) interface containing methods for examining and modifying information about components contained in a requester's Backup Components Document.

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 IVssBackupComponents::AddComponent method.

Information about components explicitly added during a restore operation using IVssBackupComponents::AddRestoreSubcomponent are not available through the IVssComponent interface.

Some information common to both components and implicitly selected subcomponents available through IVssComponent objects includes the following:

  • Backup time stamp
  • Pre-/post-restore Failure Messages
  • Restore metadata
  • Restore target

Some information in the IVssComponent object is on a per-file basis and can refer to files managed either by explicitly selected components or by implicitly selected subcomponents:

  • Alternate location mappings
  • Partial files
  • Directed target

Other information is not included in the Backup Components Document and can be inferred using the IVssComponent object in conjunction with the appropriate Writer Metadata Documents based on a writer's component hierarchy expressed in the logical paths (see Working with Selectability and Logical Paths).

The interface can be used by either a writer or a requester, although certain methods are supported only for writers. In this way, a writer can request changes in a backup or restore operation, such as adding a new target, or learn of requester actions, such as the use of an alternate location.

The following methods return an IVssComponent interface:

Members

The IVssComponent interface inherits from the IUnknown interface. IVssComponent also has these types of members:

Methods

The IVssComponent interface has these methods.

MethodDescription
AddDifferencedFilesByLastModifyLSN

Reserved for system use.

AddDifferencedFilesByLastModifyTime

Used by supporting writers to return its differenced files for incremental or differential backup on the basis of the time of the last file modification.

AddDirectedTarget

Adds a directed target specification.

AddPartialFile

Indicates that only portions of a file are to be backed up.

GetAdditionalRestores

Indicates whether additional restores will occur for the current component.

GetAlternateLocationMapping

Returns the location of data restored to an alternate location.

GetAlternateLocationMappingCount

Returns the number of alternate location mappings used by a requester in restoring data.

GetBackupMetadata

Returns the backup metadata set by CVssWriter::OnPrepareBackup.

GetBackupOptions

Returns the backup options associated with the writer.

GetBackupStamp

Returns a store backup stamp.

GetBackupSucceeded

Indicates whether the backup operation was successful.

GetComponentName

Returns the logical name of this component.

GetComponentType

Returns the type of this component.

GetDifferencedFile

Returns information about a specified file specification supporting an incremental or differential backup or restore as a differenced file.

GetDifferencedFilesCount

Returns the number of file specifications marked by a writer as supporting an incremental or differential backup or restore as a differenced file.

GetDirectedTarget

Returns information about a specified directed target.

GetDirectedTargetCount

Returns the number of directed target specifications.

GetFileRestoreStatus

Determines whether all of the files were successfully restored.

GetLogicalPath

Returns the logical path of this component.

GetNewTarget

Returns information about a new target restore location.

GetNewTargetCount

Returns the count of new target restore locations.

GetPartialFile

Returns information on a partial file to be backed up.

GetPartialFileCount

Returns the number of partial files to be backed up.

GetPostRestoreFailureMsg

Returns the failure message returned by the component's writer while handling the PostRestore event.

GetPreRestoreFailureMsg

Returns the failure message returned by the component's writer while handling the PreRestore event.

GetPreviousBackupStamp

Returns the backup stamp of an earlier backup operation upon which to base a differential or incremental backup.

GetRestoreMetadata

Returns the restore metadata associated with the current component.

GetRestoreOptions

Returns the restore options associated with the writer.

GetRestoreSubcomponent

Returns the specified subcomponent to be restored.

GetRestoreSubcomponentCount

Returns the number of subcomponents to be restored.

GetRestoreTarget

Returns the restore target associated with the current component.

IsSelectedForRestore

Determines if the component has been selected to be restored.

SetBackupMetadata

Associates backup metadata with the component.

SetBackupStamp

Sets the backup stamp indicating the time of a backup operation.

SetPostRestoreFailureMsg

Sets the failure message for the PostRestore event.

SetPreRestoreFailureMsg

Sets the failure message for the PreRestore event.

SetRestoreMetadata

Sets the restore metadata for the current component.

SetRestoreTarget

Sets the restore target for the current component.

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

VsWriter.h (include Vss.h or VsWriter.h)

Library

VssApi.lib

 

 

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft