Interface IVssWMComponent

IVssWMComponent is a class that allows access to component information stored in a Writer Metadata Document. Instances of IVssWMComponent are obtained by enumerating .

Inherited Members

IDisposable.Dispose()

Namespace: Alphaleonis.Win32.Vss

Assembly: AlphaVSS.Common.dll

Syntax

public interface IVssWMComponent : IDisposable

Properties

Caption

The description of the component. A caption string can be null.

Declaration

string Caption { get; }

Property Value

Type	Description
String

ComponentFlags

A bit mask (or bitwise OR) of values of the VssComponentFlags enumeration, indicating the features this component supports.

Declaration

VssComponentFlags ComponentFlags { get; }

Property Value

Type	Description
VssComponentFlags

Remarks

note

Windows Server 2003 and Windows XP: Before Windows Server 2003 SP1, this member is reserved for system use and will always return None.

ComponentName

The name of the component. A component name string cannot be null.

Declaration

string ComponentName { get; }

Property Value

Type	Description
String

DatabaseFiles

A list of VssWMFileDescriptor instances containing information about the database backup component files.

Declaration

IList<VssWMFileDescriptor> DatabaseFiles { get; }

Property Value

Type	Description
IList<VssWMFileDescriptor>

DatabaseLogFiles

A list of file descriptors for the log files associated with the specified database backup component.

Declaration

IList<VssWMFileDescriptor> DatabaseLogFiles { get; }

Property Value

Type	Description
IList<VssWMFileDescriptor>

Dependencies

A list of VssWMDependency instances containing accessors for obtaining information about explicit writer-component dependencies of one of the current components.

Declaration

IList<VssWMDependency> Dependencies { get; }

Property Value

Type	Description
IList<VssWMDependency>

Remarks

This will always be an empty list on operating systems earlier than Windows Server 2003.

Files

The file descriptors associated with this component.

Declaration

IList<VssWMFileDescriptor> Files { get; }

Property Value

Type	Description
IList<VssWMFileDescriptor>

Remarks

This collection represents the method GetFile() of IVssWMComponent in the VSS API

LogicalPath

The logical path of the component.

Declaration

string LogicalPath { get; }

Property Value

Type	Description
String	A string containing the logical path of the component, which may be null. There are no restrictions on the characters that can appear in a non-NULL logical path.

NotifyOnBackupComplete

Reserved for future use.

Declaration

bool NotifyOnBackupComplete { get; }

Property Value

Type	Description
Boolean

RestoreMetadata

Boolean that indicates whether there is private metadata associated with the restoration of the component.

Declaration

bool RestoreMetadata { get; }

Property Value

Type	Description
Boolean	The Boolean is true if there is private metadata associated with the restoration of the components, and false if there is not.

Selectable

Boolean that indicates (for component mode operations) if the component is selectable for backup.

Declaration

bool Selectable { get; }

Property Value

Type	Description
Boolean	true if the component is selectable for backup and false if it is not.

Remarks

The value of Selectable helps determine whether a requester has the option of including or excluding a given component in backup operations.

See Also

VSS_COMPONENTINFO structure on MSDN

SelectableForRestore

Boolean that indicates (for component-mode operations) whether the component is selectable for restore.

Declaration

bool SelectableForRestore { get; }

Property Value

Type	Description
Boolean	The Boolean is true if the component is selectable for restore and false if it is not.

Remarks

SelectableForRestore allows the requester to determine whether this component can be individually selected for restore if it had earlier been implicitly included in the backup.

note

Windows XP: This requires Windows Server 2003 or later. It will always return false on earlier operating systems.

Type

The component type.

Declaration

VssComponentType Type { get; }

Property Value

Type	Description
VssComponentType

Methods

GetIcon()

Gets a buffer containing the binary data for a displayable icon representing the component.

Declaration

byte[] GetIcon()

Returns

Type	Description
Byte[]	A buffer containing the binary data for a displayable icon representing the component.

Remarks

The buffer contents should use the same format as the standard icon (.ico) files. If the writer that created the component did not choose to specify an icon, the value will be null.