TVolFormatParam Class Reference

class TVolFormatParam

Base class for volume formatting parameters. This class package buffer, TVolFormatParamBuf or packaged buffer of the derived class can be passed to the RFormat::Open() in order to provide file system-specific formatting parameters. Each file system that supports such formatting parameters shall have this class specialisation (e.g. TVolFormatParam_FAT) All classes, derived from this one must have the same size as the base class. In order to use formatting parameters the format mode shall have ESpecialFormat bit flag set.

RFormat::Open(RFs&,const TDesC&,TUint,TInt& ,const TDesC8& anInfo);

TVolFormatParamBuf

Public Member Functions
TVolFormatParam()
TUint32 CalcFSNameHash(const TDesC &)
TUint32 FSNameHash()
voidInit()
voidSetFileSystemName(const TDesC &)
TBool SomeParamsSet()
Protected Member Functions
TUint32 GetVal(TUint)
voidSetVal(TUint, TUint32)
Public Attributes
const TUint32iUId
Private Attributes
TUint32 iData
TUint32 iFSysNameHash
TBool iParamsSet

Constructor & Destructor Documentation

TVolFormatParam()

TVolFormatParam()[inline]

Member Functions Documentation

CalcFSNameHash(const TDesC &)

TUint32 CalcFSNameHash(const TDesC &aFsName)[static, inline]

Calculates the file system name hash. For use in conjunction with this class only The file system name hash is a standard CRC32 on the up-cased name.

CRC32 name hash value

Parameters

const TDesC & aFsNamegiven name.

FSNameHash()

TUint32 FSNameHash()const [inline]

file system name hash that was wet by SetFileSystemName()

GetVal(TUint)

TUint32 GetVal(TUintaIndex)const [protected, inline]

data from the specified slot

Parameters

TUint aIndex

Init()

voidInit()[inline]

resets all data to the "not set" values

SetFileSystemName(const TDesC &)

voidSetFileSystemName(const TDesC &aFsName)[inline]

sets the file system name hash corresponding to aFsName

Parameters

const TDesC & aFsName

SetVal(TUint, TUint32)

voidSetVal(TUintaIndex,
TUint32aVal
)[protected, inline]

assign a data slot some integer value.

Parameters

TUint aIndex
TUint32 aVal

SomeParamsSet()

TBool SomeParamsSet()const [inline]

ETrue if the user has set at least one parameter apart from the file sysetm name, i.e. SetVal() was called

Member Data Documentation

TUint32 iData

TUint32 iData[private]

TUint32 iFSysNameHash

TUint32 iFSysNameHash[private]

TBool iParamsSet

TBool iParamsSet[private]

const TUint32 iUId

const TUint32iUId

This class tree UID. Used to distinguish the object of this class from TLDFormatInfo and other possible data structures. For this and derived classes this field must be KUId. This field offset in the class must be 0