Table of Contents

Class WindowsDiskVolume

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a volume on a Windows machine. This only applies to Windows 2003 and above.

public class WindowsDiskVolume : GlobalSerializableClassicBase, IComparable<WindowsDiskVolume>
Inheritance
WindowsDiskVolume
Implements

Constructors

WindowsDiskVolume()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.WindowsDiskVolume class.

public WindowsDiskVolume()

Properties

BlockSize

Gets or sets the blocksize of the volume in bytes.

public ulong BlockSize { get; set; }

Property Value

ulong

Capacity

Gets or sets the capacity of the volume in bytes.

public ulong Capacity { get; set; }

Property Value

ulong

CapacityString

Gets the capacity of the volume.

public string CapacityString { get; set; }

Property Value

string

CollectionIndex

Gets the collection index for this drive.

[Browsable(false)]
public string CollectionIndex { get; }

Property Value

string

DisplayName

Gets the name and label of the volume if available - for example "C:" or "C:\ (System)".

public string DisplayName { get; set; }

Property Value

string

DriveLetter

Gets or sets the optional drive letter assigned to this volume - for example "D:".

public string DriveLetter { get; set; }

Property Value

string

FileSystem

Gets or sets the file system installed on the volume - for example "NTFS".

public string FileSystem { get; set; }

Property Value

string

FreeSpace

Gets or sets the amount of free space on the volume in bytes.

public ulong FreeSpace { get; set; }

Property Value

ulong

FreeSpaceString

Gets the free space available on the volume as a human readable string.

public string FreeSpaceString { get; set; }

Property Value

string

Id

Gets or sets the unique identifier of the volume in GUID format - for example "41d0b186-f091-11e2-be66-806e6f6e6963".

public string Id { get; set; }

Property Value

string

IsRecoveryPartition

Gets or sets whether the volume is a recovery partition. This only applies to GPT disks.

public BooleanOption IsRecoveryPartition { get; set; }

Property Value

BooleanOption

IsSystemPartition

Gets or sets whether the volume is an EFI system partition. This only applies to GPT disks.

public BooleanOption IsSystemPartition { get; set; }

Property Value

BooleanOption

Label

Gets or sets the optional caption assigned to the drive letter - for example "Data" or "System Reserved".

public string Label { get; set; }

Property Value

string

MountPoints

Gets or sets the additional mount points for this volume. This does not include the drive letter of the volume.

public SerializableStringCollection MountPoints { get; set; }

Property Value

SerializableStringCollection

PercentageFree

Gets the percentage of space that is free on this volume.

public int PercentageFree { get; set; }

Property Value

int

PercentageUsed

Gets the percentage of space that is used on this volume.

public int PercentageUsed { get; set; }

Property Value

int

Security

Gets or sets the NTFS security descriptor for the drive if available.

public NtfsSecurityDescriptor Security { get; set; }

Property Value

NtfsSecurityDescriptor

ShadowCopyConfiguration

Gets or sets the shadow copy configuration for the volume. This applies only to Windows server operating systems.

public VolumeShadowCopyConfiguration ShadowCopyConfiguration { get; set; }

Property Value

VolumeShadowCopyConfiguration

UsedSpaceString

Gets the space used on the volume.

public string UsedSpaceString { get; set; }

Property Value

string

Methods

CompareTo(WindowsDiskVolume)

Compares two CENTREL.XIA.Configuration.Types.WindowsDiskVolume objects to allow them to be sorted alphabetically by drive letter.

public int CompareTo(WindowsDiskVolume other)

Parameters

other WindowsDiskVolume

The CENTREL.XIA.Configuration.Types.WindowsDiskVolume to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.WindowsDiskVolume objects.

ToString()

Returns the name of the volume.

public override string ToString()

Returns

string

The name of the volume.