Interface IVssFactory

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

Namespace: Alphaleonis.Win32.Vss

Assembly: AlphaVSS.Common.dll

Syntax

public interface IVssFactory

Remarks

An instance of IVssFactory can be obtained either by using the VssFactoryProvider (recommended), or in advanced scenarios by statically referencing the correct platform-specific assembly and manually creating an instance of VssFactory from that assembly.

Methods

CreateVssBackupComponents()

The CreateVssBackupComponents method creates an IVssBackupComponents interface object for the current implementation and returns a reference to it.

Declaration

IVssBackupComponents CreateVssBackupComponents()

Returns

Type	Description
IVssBackupComponents	A reference to the newly created IVssBackupComponents instance.

Remarks

The calling application is responsible for calling Dispose" to release the resources held by the IVssBackupComponents instance when it is no longer needed.

Exceptions

Type	Condition
UnauthorizedAccessException	The caller does not have sufficient backup privileges or is not an administrator.
OutOfMemoryException	Out of memory or other system resources.
SystemException	Unexpected VSS system error. The error code is logged in the event log.

See Also

IVssBackupComponents

CreateVssExamineWriterMetadata(String)

The CreateVssExamineWriterMetadata function creates a new IVssExamineWriterMetadata instance from an XML document for the current implementation.

Declaration

IVssExamineWriterMetadata CreateVssExamineWriterMetadata(string xml)

Parameters

Type	Name	Description
String	xml	A string containing a Writer Metadata Document with which to initialize the returned IVssExamineWriterMetadata object.

Returns

Type	Description
IVssExamineWriterMetadata	a IVssExamineWriterMetadata instance initialized with the specified XML document.

Remarks

This method attempts to load the returned IVssExamineWriterMetadata object with metadata previously stored by a call to SaveAsXml(). Users should not tamper with this metadata document.

CreateVssSnapshotManagement()

Gets a snapshot management interface for the current implementation.

Declaration

IVssSnapshotManagement CreateVssSnapshotManagement()

Returns

Type	Description
IVssSnapshotManagement	A snapshot management interface for the current implementation.

GetInfoProvider()

Gets an instance of IVssInfoProvider.

Declaration

IVssInfoProvider GetInfoProvider()

Returns

Type	Description
IVssInfoProvider	An instance of IVssInfoProvider.

See Also

VssFactoryProvider