Class VssWMFileDescriptor

The VssWMFileDescriptor class is returned to a calling application by a number of query methods. It provides detailed information about a file or set of files (a file set).

Inheritance

Object

VssWMFileDescriptor

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Alphaleonis.Win32.Vss

Assembly: AlphaVSS.Common.dll

Syntax

[Serializable]
public class VssWMFileDescriptor

Remarks

The following methods return a VssWMFileDescriptor instance:

• AlternateLocationMappings
• NewTargets
• ExcludeFiles
• AlternateLocationMappings
• Files
• DatabaseFiles
• DatabaseLogFiles

Constructors

VssWMFileDescriptor(String, VssFileSpecificationBackupType, String, String, Boolean)

Initializes a new instance of the VssWMFileDescriptor class.

Declaration

public VssWMFileDescriptor(string alternateLocation, VssFileSpecificationBackupType backupTypeMask, string fileSpecification, string path, bool isRecursive)

Parameters

Type	Name	Description
String	alternateLocation	The alternate location.
VssFileSpecificationBackupType	backupTypeMask	The backup type mask.
String	fileSpecification	The file specification.
String	path	The path.
Boolean	isRecursive	if set to true this file description is recursive.

Properties

AlternateLocation

Obtains the alternate backup location of the component files.

Declaration

public string AlternateLocation { get; }

Property Value

Type	Description
String

BackupTypeMask

Obtains the file backup specification for a file or set of files.

Declaration

public VssFileSpecificationBackupType BackupTypeMask { get; }

Property Value

Type	Description
VssFileSpecificationBackupType

Remarks

note

Windows XP: This value is not supported in Windows XP and will always return Unknown

FileSpecification

Obtains the file specification for the list of files provided.

Declaration

public string FileSpecification { get; }

Property Value

Type	Description
String

IsRecursive

Determines whether only files in the root directory or files in the entire directory hierarchy are considered for backup.

Declaration

public bool IsRecursive { get; }

Property Value

Type	Description
Boolean

Remarks

VSS API reference: IVssWMFiledesc::GetRecursive()

Path

Obtains the fully qualified directory path for the list of files provided.

Declaration

public string Path { get; }

Property Value

Type	Description
String