Collapse all Symbian^3 Product Developer Library

FileSystem_FAT::TVolFormatParam_FAT Class Reference

class FileSystem_FAT::TVolFormatParam_FAT : public TVolFormatParam

This class describes specific parameters for formatting volume with FAT file system. The parameters are: FAT sub type (FAT12/16/32), Number of Sectors per cluster, Number of FAT tables, Number of reserved sectors. All parameters are optional and if not set, it is up to the file system implementation to decide values.

This class package (TVolFormatParam_FATBuf) shall be passed to the RFormat::Open() as "Special format information"

Please note that the parameters may have invalid combinations and it is not always possible to format volume with the specified FAT sub type, like FAT12. In this case RFormat::Open() will return corresponding error code (the concrete code depends on file system implementation).

RFormat::Open() does not modify any data in this structure.

TVolFormatParam_FATBuf RFormat::Open()

Inherits from

FileSystem_FAT::TVolFormatParam_FAT
- TVolFormatParam

Public Member Functions
	TVolFormatParam_FAT()
TFatSubType	FatSubType()
void	Init()
TUint32	NumFATs()
TUint32	ReservedSectors()
TUint32	SectPerCluster()
void	SetFatSubType(TFatSubType)
void	SetFatSubType(const TDesC &)
void	SetNumFATs(TUint32)
void	SetReservedSectors(TUint32)
void	SetSectPerCluster(TUint32)

Private Member Functions
void	SetFileSystemName(const TDesC &)

Inherited Functions
	TVolFormatParam::CalcFSNameHash(const TDesC &)
	TVolFormatParam::FSNameHash()const
	TVolFormatParam::GetVal(TUint)const
	TVolFormatParam::SetVal(TUint,TUint32)
	TVolFormatParam::SomeParamsSet()const
	TVolFormatParam::TVolFormatParam()

Private Member Enumerations
enum	anonymous { KOffsetSubType = 0, KOffsetReservedSec, KOffsetSpc, KOffsetNumFATs }

Inherited Enumerations
	TVolFormatParam:@38
	TVolFormatParam:@39

Inherited Attributes
	TVolFormatParam::iUId

Constructor & Destructor Documentation

TVolFormatParam_FAT()

TVolFormatParam_FAT

(

)

[inline]

Member Functions Documentation

FatSubType()

TFatSubType

FatSubType

(

)

const [inline]

Init()

void

Init

(

)

[inline]

initialises the data structure with default values for all parameters and automatically sets file system name as "FAT"

NumFATs()

TUint32

NumFATs

(

)

const [inline]

ReservedSectors()

TUint32

ReservedSectors

(

)

const [inline]

SectPerCluster()

TUint32

SectPerCluster

(

)

const [inline]

SetFatSubType(TFatSubType)

void

SetFatSubType

(

TFatSubType

aSubType

)

[inline]

Set desired FAT subtype.

Parameters

TFatSubType aSubType

specifies FAT12/16/32 subtype. Value 0 means "the file system will decide itself what to use"

SetFatSubType(const TDesC &)

void

SetFatSubType

(

const TDesC &

aSubType

)

[inline]

Set desired FAT subtype using string literals, KFSSubType_FAT12, KFSSubType_FAT16, KFSSubType_FAT32

Parameters

const TDesC & aSubType

string descriptor, like "FAT16"

SetFileSystemName(const TDesC &)

void

SetFileSystemName

(

const TDesC &

aFsName

)

[private]

sets the file system name hash corresponding to aFsName

Parameters

const TDesC & aFsName

SetNumFATs(TUint32)

void

SetNumFATs

(

TUint32

aNumFATs

)

[inline]

Set Number of FAT tables on the volume. The maximum is supported by the FAT FS implementation is 2

Parameters

TUint32 aNumFATs

Number of FAT tables. Value 0 means "the file system will decide itself what to use"

SetReservedSectors(TUint32)

void

SetReservedSectors

(

TUint32

aReservedSectors

)

[inline]

Set number of reserved sectors on FAT volume. The file system will validate this parameter before formatting.

Parameters

TUint32 aReservedSectors

number of reserved sectors. Value 0 means "the file system will decide itself what to use"

SetSectPerCluster(TUint32)

void

SetSectPerCluster

(

TUint32

aSpc

)

[inline]

Set Number of "Sectors per cluster". For valid values see FAT specs.

Parameters

TUint32 aSpc

Number of "Sectors per cluster". Value 0 means "the file system will decide itself what to use"

Member Enumerations Documentation

Enum anonymous

Enumerators

KOffsetSubType = 0
KOffsetReservedSec
KOffsetSpc
KOffsetNumFATs