Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
TVolumeInfo Class Reference

Contains information about a volume mounted on a drive. More...

#include <f32file.h>

Public Member Functions

IMPORT_C TVolumeInfo ()
 Default constructor.
 

Public Attributes

TDriveInfo iDrive
 Information about the drive on which the volume is mounted.
 
TUint iUniqueID
 The volume’s unique identifying number.
 
TInt64 iSize
 The maximum size of the volume in bytes.
 
TInt64 iFree
 The amount of free space on the volume in bytes.
 
TBufC< KMaxFileName > iName
 Name of the volume, with a maximum of KMaxFileName characters.
 
TFileCacheFlags iFileCacheFlags
 Flags which define the default file-caching behaviour for this volume.
 
TUint8 iVolSizeAsync: 1
 

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()
API status
Published to all clients. Released API.

Definition at line 1657 of file f32file.h.

Constructor & Destructor Documentation

◆ TVolumeInfo()

IMPORT_C TVolumeInfo::TVolumeInfo ( )

Default constructor.

(generated from Symbian Developer Library)

Member Data Documentation

◆ iDrive

TDriveInfo TVolumeInfo::iDrive

Information about the drive on which the volume is mounted.

See also
TDriveInfo

Definition at line 1687 of file f32file.h.

◆ iFileCacheFlags

TFileCacheFlags TVolumeInfo::iFileCacheFlags

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

See also
TFileCacheFlags

Definition at line 1723 of file f32file.h.

◆ iFree

TInt64 TVolumeInfo::iFree

The amount of free space on the volume in bytes.

Definition at line 1706 of file f32file.h.

◆ iName

TBufC<KMaxFileName> TVolumeInfo::iName

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

This field is optional.

See also
KMaxFileName

Definition at line 1716 of file f32file.h.

◆ iSize

TInt64 TVolumeInfo::iSize

The maximum size of the volume in bytes.

The current amount of memory in use plus the amount of free memory.

Definition at line 1700 of file f32file.h.

◆ iUniqueID

TUint TVolumeInfo::iUniqueID

The volume’s unique identifying number.

Definition at line 1693 of file f32file.h.

◆ iVolSizeAsync

TUint8 TVolumeInfo::iVolSizeAsync
Internal flag, used in the case of non-blocking getting volume information. 
@see 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.
API status
Prototype: Internal technology API.

Definition at line 1738 of file f32file.h.


The documentation for this class was generated from the following files: