Class VssSnapshotProperties

The VssSnapshotProperties class contains the properties of a shadow copy or shadow copy set.

Inheritance

Object

VssSnapshotProperties

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 VssSnapshotProperties

Constructors

VssSnapshotProperties(Guid, Guid, Int64, String, String, String, String, String, String, Guid, VssVolumeSnapshotAttributes, DateTime, VssSnapshotState)

Initializes a new instance of the VssSnapshotProperties class.

Declaration

public VssSnapshotProperties(Guid snapshotId, Guid snapshotSetId, long snapshotCount, string snapshotDeviceObject, string originalVolumeName, string originatingMachine, string serviceMachine, string exposedName, string exposedPath, Guid providerId, VssVolumeSnapshotAttributes snapshotAttributes, DateTime creationTimestamp, VssSnapshotState snapshotState)

Parameters

Type	Name	Description
Guid	snapshotId	The snapshot id.
Guid	snapshotSetId	The snapshot set id.
Int64	snapshotCount	The snapshot count.
String	snapshotDeviceObject	The snapshot device object.
String	originalVolumeName	Name of the original volume.
String	originatingMachine	The originating machine.
String	serviceMachine	The service machine.
String	exposedName	Name of the exposed.
String	exposedPath	The exposed path.
Guid	providerId	The provider id.
VssVolumeSnapshotAttributes	snapshotAttributes	The snapshot attributes.
DateTime	creationTimestamp	The creation timestamp.
VssSnapshotState	snapshotState	State of the snapshot.

Properties

CreationTimestamp

Time stamp indicating when the shadow copy was created. The exact time is determined by the provider.

Declaration

public DateTime CreationTimestamp { get; }

Property Value

Type	Description
DateTime

ExposedName

The name of the shadow copy when it is exposed. This is a drive letter or mount point (if the shadow copy is exposed as a local volume), or a share name.

Declaration

public string ExposedName { get; }

Property Value

Type	Description
String

ExposedPath

The portion of the shadow copy of a volume made available if it is exposed as a share.

Declaration

public string ExposedPath { get; }

Property Value

Type	Description
String

OriginalVolumeName

The name of the volume that had been shadow copied.

Declaration

public string OriginalVolumeName { get; }

Property Value

Type	Description
String

OriginatingMachine

The name of the machine containing the original volume.

Declaration

public string OriginatingMachine { get; }

Property Value

Type	Description
String

ProviderId

A Guid uniquely identifying the provider used to create this shadow copy.

Declaration

public Guid ProviderId { get; }

Property Value

Type	Description
Guid

ServiceMachine

The name of the machine running the Volume Shadow Copy Service that created the shadow copy.

Declaration

public string ServiceMachine { get; }

Property Value

Type	Description
String

SnapshotAttributes

The attributes of the shadow copy expressed as a bit mask (or bitwise OR) of members of the VssVolumeSnapshotAttributes enumeration.

Declaration

public VssVolumeSnapshotAttributes SnapshotAttributes { get; }

Property Value

Type	Description
VssVolumeSnapshotAttributes

SnapshotDeviceObject

The name of the device object for the shadow copy of the volume. The device object can be thought of as the root of a shadow copy of a volume. Requesters will use this device name when accessing files on a shadow-copied volume that it needs to work with.

The device name does not contain a trailing "\".

Declaration

public string SnapshotDeviceObject { get; }

Property Value

Type	Description
String

SnapshotId

A Guid uniquely identifying the shadow copy identifier.

Declaration

public Guid SnapshotId { get; }

Property Value

Type	Description
Guid

SnapshotsCount

Number of volumes included with the shadow copy in the shadow copy set when it was created. Because it is possible for applications to release individual shadow copies without releasing the shadow copy set, at any given time the number of shadow copies in the shadow copy set may be less than SnapshotsCount

The maximum number of shadow-copied volumes permitted in a shadow copy set is 64.

Declaration

public long SnapshotsCount { get; }

Property Value

Type	Description
Int64

SnapshotSetId

A Guid uniquely identifying the shadow copy set containing the shadow copy.

Declaration

public Guid SnapshotSetId { get; }

Property Value

Type	Description
Guid

Status

Current shadow copy creation status. See VssSnapshotState.

Declaration

public VssSnapshotState Status { get; }

Property Value

Type	Description
VssSnapshotState