IVssExamineWriterMetadata class (vsbackup.h)
The IVssExamineWriterMetadata interface is a C++ (not COM) interface 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.
An IVssExamineWriterMetadata interface to a live writer's metadata is obtained by a call to IVssBackupComponents::GetWriterMetadata.
Metadata obtained from a stored XML document can be examined by an instance of IVssExamineWriterMetadata obtained by a call to CreateVssExamineWriterMetadata.
Inheritance
The IVssExamineWriterMetadata interface inherits from the IUnknown interface. IVssExamineWriterMetadata also has these types of members:
Methods
The IVssExamineWriterMetadata class has these methods.
| IVssExamineWriterMetadata::GetAlternateLocationMapping The GetAlternateLocationMapping method obtains a specific alternate location mapping of a file set. |
| IVssExamineWriterMetadata::GetBackupSchema The GetBackupSchema method is used by a requester to determine from the Writer Metadata Document the types of backup operations that a given writer can participate in. |
| IVssExamineWriterMetadata::GetComponent The GetComponent method obtains a Writer Metadata Document for a specified backup component. |
| IVssExamineWriterMetadata::GetDocument Not supported. (IVssExamineWriterMetadata.GetDocument) |
| IVssExamineWriterMetadata::GetExcludeFile The GetExcludeFile method obtains information about files that have been explicitly excluded from backup for a given writer. |
| IVssExamineWriterMetadata::GetFileCounts The GetFileCounts method obtains excluded files and the number of components that a writer manages. |
| IVssExamineWriterMetadata::GetIdentity The GetIdentity method obtains basic information about a specific writer instance. |
| IVssExamineWriterMetadata::GetIncludeFile Not supported. (IVssExamineWriterMetadata.GetIncludeFile) |
| IVssExamineWriterMetadata::GetRestoreMethod The GetRestoreMethod method returns information about how a writer wants its data to be restored. |
| IVssExamineWriterMetadata::LoadFromXML The LoadFromXML method loads an XML document that contains a writer's metadata document into an IVssExamineWriterMetadata interface. |
| IVssExamineWriterMetadata::SaveAsXML The SaveAsXML method saves the Writer Metadata Document that contains a writer's state information to a specified string. This string can be saved as part of a backup operation. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h) |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for