Documentation | StorageKit | Volume

SYNOPSIS

use HaikuR1::Volume;

$volume->GetName();

import HaikuR1.Volume

volume.GetName()

DESCRIPTION

Exposes the BVolume object.

For more information on Volume, see the Be Book class description, the Be Book overview, and the Haiku Book class description.

METHODS

Constructor

Creates a Volume.

HaikuR1::Volume->new();
HaikuR1::Volume->new($device);
HaikuR1::Volume->new($volume);

Volume()
Volume(device)
Volume(volume)

• device

  A device id.

• volume

  A Volume to copy.

copy

Copies the contents of another object into this object.

$volume->copy($copy_from);

volume.copy(copy_from)

• copy_from

  A Volume to copy.

Device

SetTo

Unset

Points the Volume object to a different volume.

$volume->Device();
$volume->SetTo($device);
$volume->Unset();

volume.Device()
volume.SetTo(device)
volume.Unset()

• device

  A device id.

GetIcon

Gets the volume's icon. If you pass a size, then it returns a Bitmap; otherwise, it returns two items: the raw icon data and the type.

(Currently the type is always B_VECTOR_ICON_TYPE.)

$volume->GetIcon($size, $colorSpace);
$volume->GetIconData();

volume.GetIcon(size, colorSpace)
volume.GetIconData()

• size

  An integer icon size constant.

• colorSpace

  An integer color space constant, the color space of the returned Bitmap; defaults to B_RGBA32.

GetRootDirectory

Returns the root Directory.

$volume->GetRootDirectory();

volume.GetRootDirectory()

Name

GetName

SetName

Gets or sets the volume name.

$volume->GetName();
$volume->SetName($name);

volume.GetName()
volume.SetName(name)

• name

  A string, the new name.

Properties

Capacity

FreeBytes

BlockSize

IsRemovable

IsReadOnly

IsPersistent

IsShared

KnowsMime

KnowsAttr

KnowsQuery

Most of these methods do what you expect. The Knows methods refer to properties of the file system on the volume: whether it uses MIME for file types, whether its files have attributes, and whether it can respond to queries.

$volume->Capacity();
$volume->FreeBytes();
$volume->BlockSize();
$volume->IsRemovable();
$volume->IsReadOnly();
$volume->IsPersistent();
$volume->IsShared();
$volume->KnowsMime();
$volume->KnowsAttr();
$volume->KnowsQuery();

volume.Capacity()
volume.FreeBytes()
volume.BlockSize()
volume.IsRemovable()
volume.IsReadOnly()
volume.IsPersistent()
volume.IsShared()
volume.KnowsMime()
volume.KnowsAttr()
volume.KnowsQuery()

OPERATORS

==

Returns true if the Volume objects refer to the same volume.

!=

Returns true if the Volume objects do not refer to the same volume.