TVolumeInfo Class Reference

#include <f32file.h>

Link against: efsrv.lib

class TVolumeInfo

Detailed Description

Contains information about a volume mounted on a drive. Use RFs::Drive() if only the drive information is required.

If a drive supports removable media it may contain different volumes over time.

Volume information is made up of information concerning the drive on which it is mounted, which can also be accessed through RFs::Drive(), and the volume information, this is made up of the size of the volume, the free space, its unique identifying number and a name.

TVolumeInfo is initialised by RFs::Volume().

See also: RFs::Volume() RFs::Drive()

Member Attribute Documentation

iDrive

TDriveInfo iDrive

Information about the drive on which the volume is mounted.

See also: TDriveInfo

iFileCacheFlags

TFileCacheFlags iFileCacheFlags

Flags which define the default file-caching behaviour for this volume

See also: TFileCacheFlags

iFree

TInt64 iFree

The amount of free space on the volume in bytes.

iName

Name of the volume, with a maximum of KMaxFileName characters.

This field is optional.

See also: KMaxFileName

iSize

TInt64 iSize

The maximum size of the volume in bytes. The current amount of memory in use plus the amount of free memory.

iUniqueID

TUint iUniqueID

The volume s unique identifying number.

iVolSizeAsync

TUint8 iVolSizeAsync

Internal flag, used in the case of non-blocking getting volume information.

See also: RFs::Volume(TVolumeInfo& aVol,TInt aDrive, TRequestStatus& aStat)

If this flag is set, it means that the volume information will be obtained asynchronously. More specific, on return iFree will reflect the _current_ amount of free space on volume at the moment of RFs::Volume() call, not the exact final value. This is because in this case getting volume information will be asynchronous, and the client will not be suspended until the mount finish calculating free space. At present appicable to FAT32 file system only.

Constructor & Destructor Documentation

TVolumeInfo ( )

IMPORT_CTVolumeInfo()

Default constructor.