Volume information


Section contents


Overview

Defined in

cfile.oxh

Description

<TBS>


Methods provided


VolumeInfoDriveInfo - drive information

Usage

info& = VolumeInfoDriveInfo&:(this&)

Description

Returns information about the drive on which the volume is mounted.

Arguments
this& A handle to a volume information object
Return value
info& A handle to a drive information object

VolumeInfoFree - free space

Usage

size& = VolumeInfoFree&:(this&)

Description

Returns the free space.

Arguments
this& A handle to a volume information object
Return value
size& A handle to an Int64 object

VolumeInfoName - volume name

Usage

name$ = VolumeInfoName$:(this&)

Description

Returns the (optional) name of the volume.

Arguments
this& A handle to a volume information object
Return value
name$ The name of the volume
Error Handling

If the name$ string cannot be created then an error is generated which should be trapped by an ONERR handler.


VolumeInfoSize - maximum size

Usage

size& = VolumeInfoSize&:(this&)

Description

Returns the maximum size.

Arguments
this& A handle to a volume information object
Return value
size& A handle to an Int64 object

VolumeInfoUniqueId - volume unique ID

Usage

id& = VolumeInfoUniqueId&:(this&)

Description

Returns the volume's unique ID.

Arguments
this& A handle to a volume information object
Return value
id& The unique id of the volume