FileSystem_FAT::TVolFormatParam_FAT Class Reference

#include <filesystem_fat.h>

class FileSystem_FAT::TVolFormatParam_FAT : public TVolFormatParam

Inherits from

  • FileSystem_FAT::TVolFormatParam_FAT
    Public Member Functions
    TVolFormatParam_FAT()
    TFatSubType FatSubType()
    voidInit()
    TUint32 NumFATs()
    TUint32 ReservedSectors()
    TUint32 SectPerCluster()
    voidSetFatSubType(TFatSubType)
    voidSetFatSubType(const TDesC &)
    voidSetNumFATs(TUint32)
    voidSetReservedSectors(TUint32)
    voidSetSectPerCluster(TUint32)
    Inherited Attributes
    TVolFormatParam::iUId
    Inherited Enumerations
    TVolFormatParam:@38
    TVolFormatParam:@39
    Inherited Functions
    TVolFormatParam::CalcFSNameHash(const TDesC &)
    TVolFormatParam::FSNameHash()const
    TVolFormatParam::GetVal(TUint)const
    TVolFormatParam::SetVal(TUint,TUint32)
    TVolFormatParam::SomeParamsSet()const
    TVolFormatParam::TVolFormatParam()

    Detailed Description

    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.

    See also: TVolFormatParam_FATBuf RFormat::Open()

    Constructor & Destructor Documentation

    TVolFormatParam_FAT ( )

    TVolFormatParam_FAT()[inline]

    Member Function Documentation

    FatSubType ( )

    TFatSubType FatSubType()const [inline]

    Returns: FAT sub type value, which is set by SetFatSubType()

    Init ( )

    voidInit()[inline]

    Reimplemented from TVolFormatParam::Init()

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

    NumFATs ( )

    TUint32 NumFATs()const [inline]

    Returns: value previously set by SetNumFATs()

    ReservedSectors ( )

    TUint32 ReservedSectors()const [inline]

    Returns: value previously set by SetReservedSectors()

    SectPerCluster ( )

    TUint32 SectPerCluster()const [inline]

    Returns: value previously set by SetSectPerCluster()

    SetFatSubType ( TFatSubType )

    voidSetFatSubType(TFatSubTypeaSubType)[inline]

    Set desired FAT subtype.

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

    SetFatSubType ( const TDesC & )

    voidSetFatSubType(const TDesC &aSubType)[inline]

    Set desired FAT subtype using string literals,

    See also: KFSSubType_FAT12, KFSSubType_FAT16, KFSSubType_FAT32

    ParameterDescription
    aSubTypestring descriptor, like "FAT16"

    SetNumFATs ( TUint32 )

    voidSetNumFATs(TUint32aNumFATs)[inline]

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

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

    SetReservedSectors ( TUint32 )

    voidSetReservedSectors(TUint32aReservedSectors)[inline]

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

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

    SetSectPerCluster ( TUint32 )

    voidSetSectPerCluster(TUint32aSpc)[inline]

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

    ParameterDescription
    aSpcNumber of "Sectors per cluster". Value 0 means "the file system will decide itself what to use"
    © Nokia 2011.