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

Inherited Members

IDisposable.Dispose()

Namespace: Alphaleonis.Win32.Vss

Assembly: AlphaVSS.Common.dll

Syntax

public interface IVssExamineWriterMetadata : IDisposable

Remarks

A IVssExamineWriterMetadata interface to a live writer's metadata is obtained by a call to WriterMetadata.

Properties

| Improve this Doc View Source

AlternateLocationMappings

The alternate location mappings of the file sets.

Declaration

IList<VssWMFileDescriptor> AlternateLocationMappings { get; }

Property Value

Type	Description
IList<VssWMFileDescriptor>	A read-only list containing the alternate location mappings of the file sets.

| Improve this Doc View Source

BackupSchema

The BackupSchema is examined by a requester to determine from the Writer Metadata Document the types of backup operations that a given writer can participate in.

Declaration

VssBackupSchema BackupSchema { get; }

Property Value

Type	Description
VssBackupSchema

| Improve this Doc View Source

Components

Obtains the Writer Metadata Documents the components supported by this writer.

Declaration

IList<IVssWMComponent> Components { get; }

Property Value

Type	Description
IList<IVssWMComponent>	the Writer Metadata Documents the components supported by this writer.

| Improve this Doc View Source

ExcludeFiles

Information about files that have been explicitly excluded from backup.

Declaration

IList<VssWMFileDescriptor> ExcludeFiles { get; }

Property Value

Type	Description
IList<VssWMFileDescriptor>	a read-only list containing information about files that have been explicitly excluded from backup.

| Improve this Doc View Source

ExcludeFromSnapshotFiles

Obtains information about file sets that have been explicitly excluded from a given shadow copy.

Declaration

IList<VssWMFileDescriptor> ExcludeFromSnapshotFiles { get; }

Property Value

Type	Description
IList<VssWMFileDescriptor>	The exclude from snapshot files.

Remarks

The ExcludeFromSnapshotFiles property is intended to report information about file sets excluded from a shadow copy. Requesters should not exclude files from backup based on the information returned by this method.

note

Windows XP and Windows 2003: This property is not supported until Windows Vista and will always return an empty list.

| Improve this Doc View Source

InstanceId

The instance identifier of the writer

Declaration

Guid InstanceId { get; }

Property Value

Type	Description
Guid	The instance id.

| Improve this Doc View Source

InstanceName

Gets the writer instance name.

Declaration

string InstanceName { get; }

Property Value

Type	Description
String	A string specifying the writer instance name.

Remarks

note

Windows XP and Windows 2003: This property is not supported until Windows 2003 SP1 and will always return null on those systems.

| Improve this Doc View Source

RestoreMethod

Information about how a writer wants its data to be restored.

Declaration

VssWMRestoreMethod RestoreMethod { get; }

Property Value

Type	Description
VssWMRestoreMethod

| Improve this Doc View Source

Source

A VssSourceType enumeration value indicating the type of data managed by the writer.

Declaration

VssSourceType Source { get; }

Property Value

Type	Description
VssSourceType

| Improve this Doc View Source

Usage

A VssUsageType enumeration value indicating how the data managed by the writer is used on the host system.

Declaration

VssUsageType Usage { get; }

Property Value

Type	Description
VssUsageType

| Improve this Doc View Source

Version

Gets the version information for a writer application.

Declaration

Version Version { get; }

Property Value

Type	Description
Version	The version information for a writer application.

Remarks

Only the Major and Minor properties of the Version instance are used by VSS.

note

Windows XP and Windows 2003: This property is not supported until Windows Vista, and will always return version 0.0.0.0

| Improve this Doc View Source

WriterId

The class ID of the writer

Declaration

Guid WriterId { get; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

WriterName

A string specifying the name of the writer

Declaration

string WriterName { get; }

Property Value

Type	Description
String

Methods

| Improve this Doc View Source

LoadFromXml(String)

The LoadFromXml(String) method loads an XML document that contains a writer's metadata document into a IVssExamineWriterMetadata instance.

Declaration

bool LoadFromXml(string xml)

Parameters

Type	Name	Description
String	xml	String that contains an XML document that represents a writer's metadata document.

Returns

Type	Description
Boolean	true if the XML document was successfully loaded, or false if the XML document could not be loaded.

| Improve this Doc View Source

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.

Declaration

string SaveAsXml()

Returns

Type	Description
String	The Writer Metadata Document that contains a writer's state information.