Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | List of all members
TVolFormatParam Class Reference

Base class for volume formatting parameters. More...

#include <f32file.h>

Public Types

enum  { KUId = 0x820116A2 }
 

Public Member Functions

 TVolFormatParam ()
 
void Init ()
 resets all data to the "not set" values
 
void SetFileSystemName (const TDesC &aFsName)
 sets the file system name hash corresponding to aFsName
 
TUint32 FSNameHash () const
 
TBool SomeParamsSet () const
 

Static Public Member Functions

static TUint32 CalcFSNameHash (const TDesC &aFsName)
 Calculates the file system name hash.
 

Public Attributes

const TUint32 iUId
 This class tree UID.
 

Protected Types

enum  { KMaxDataSlots = 64 }
 

Protected Member Functions

void SetVal (TUint aIndex, TUint32 aVal)
 assign a data slot some integer value.
 
TUint32 GetVal (TUint aIndex) const
 

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    RFormat::Open(RFs&,const TDesC&,TUint,TInt& ,const TDesC8& anInfo);
@see    TVolFormatParamBuf
API status
Published to all clients. Released API.

Definition at line 2331 of file f32file.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
KMaxDataSlots 

Definition at line 2348 of file f32file.h.

◆ anonymous enum

anonymous enum
Enumerator
KUId 

Definition at line 2355 of file f32file.h.

Constructor & Destructor Documentation

◆ TVolFormatParam()

TVolFormatParam::TVolFormatParam ( )
inline

Member Function Documentation

◆ CalcFSNameHash()

static TUint32 TVolFormatParam::CalcFSNameHash ( const TDesC &  aFsName)
inlinestatic

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.

Parameters
aFsNamegiven name.

(generated from Symbian Developer Library)

◆ FSNameHash()

TUint32 TVolFormatParam::FSNameHash ( ) const
inline

◆ GetVal()

TUint32 TVolFormatParam::GetVal ( TUint  aIndex) const
inlineprotected

◆ Init()

void TVolFormatParam::Init ( )
inline

resets all data to the "not set" values

(generated from Symbian Developer Library)

◆ SetFileSystemName()

void TVolFormatParam::SetFileSystemName ( const TDesC &  aFsName)
inline

sets the file system name hash corresponding to aFsName

(generated from Symbian Developer Library)

◆ SetVal()

void TVolFormatParam::SetVal ( TUint  aIndex,
TUint32  aVal 
)
inlineprotected

assign a data slot some integer value.

(generated from Symbian Developer Library)

◆ SomeParamsSet()

TBool TVolFormatParam::SomeParamsSet ( ) const
inline

Member Data Documentation

◆ iUId

const TUint32 TVolFormatParam::iUId

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

Definition at line 2361 of file f32file.h.

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