TVolFormatParam Class Reference

#include <f32file.h>

Link against: EAACPlusAudioControllerUtility.lib

class TVolFormatParam
Public Attributes
const TUint32iUId
Public Member Enumerations
enumanonymous { KUId }
Protected Member Enumerations
enumanonymous { KMaxDataSlots }
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)

Detailed Description

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.

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

Member Attribute Documentation

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

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
KMaxDataSlots64

Enum anonymous

EnumeratorValueDescription
KUId0x820116A2

Constructor & Destructor Documentation

TVolFormatParam ( )

TVolFormatParam()[inline]

Member Function 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.

ParameterDescription
aFsNamegiven name.

Returns: CRC32 name hash value

FSNameHash ( )

TUint32 FSNameHash()const [inline]

Returns: file system name hash that was wet by SetFileSystemName()

GetVal ( TUint )

TUint32 GetVal(TUintaIndex)const [protected, inline]

Returns: data from the specified slot

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

SetVal ( TUint, TUint32 )

voidSetVal(TUintaIndex,
TUint32aVal
)[protected, inline]

assign a data slot some integer value.

SomeParamsSet ( )

TBool SomeParamsSet()const [inline]

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

© Nokia 2011.