Class SgaDrive

Namespace

OpenCompote.SGA

Assembly

OpenCompote.dll

Represents a drive within a SGA archive.

public class SgaDrive

Inheritance

object

SgaDrive

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Alias

Gets or sets the alias of the drive.

public string Alias { get; set; }

Property Value

string

Exceptions

InvalidOperationException

Setter throws this exception when the parent archive was opened in read-only mode.

ObjectDisposedException

The parent archive was already closed.

Archive

Gets the SGA archive that the drive belongs to.

public SgaArchive? Archive { get; }

Property Value

SgaArchive

Remarks

This property is null when this drive is deleted.

Name

Gets or sets the name of the drive.

public string Name { get; set; }

Property Value

string

Exceptions

InvalidOperationException

Setter throws this exception when the parent archive was opened in read-only mode.

ObjectDisposedException

The parent archive was already closed.

RootFolder

Gets the RootFolder of this drive.

public SgaFolder RootFolder { get; }

Property Value

SgaFolder

Methods

Delete()

Deletes the drive and all its contents from the archive.

public void Delete()

Remarks

When SgaDrive is deleted it is removed from the Drives list and the Archive property is set to null

Deleting already deleted drive do not change the state of the drive or throw any exception.

Exceptions

InvalidOperationException

The parent SgaArchive was open in readonly mode.

ObjectDisposedException

The parent SgaArchive has already been closed.