| class CFormatCB : public CFsDispatchObject |
A file server interface class representing a format operation on a disk.
An instance of this object is referred to as a format control block.
The type of format operation to be applied depends on the type of disk, and is stored in iMode. Each format operation has a number of steps and is kept track of using iCurrentStep.
A format control block needs to be created for a specific mount control block for the disk controlled via that mount to be formatted.
A plug-in file system provides an implementation of this class.
| Public Member Functions | |
|---|---|
| CFormatCB() | |
| ~CFormatCB() | |
| IMPORT_C TInt | CheckMount() |
| TInt & | CurrentStep() |
| void | DoFormatStepL() |
| TDrive & | Drive() |
| void | InitL(TDrive *, TFormatMode) |
| TFormatMode | Mode() |
| CMountCB & | Mount() |
| void | SetFormatParameters(const TLDFormatInfo *) |
| TInt | SetFormatParameters(const TVolFormatParam *) |
| Protected Member Functions | |
|---|---|
| IMPORT_C TInt | GetInterface(TInt, TAny *&, TAny *) |
| Protected Member Enumerations | |
|---|---|
| enum | TInterfaceIds { ESetFmtParameters = 1 } |
| Protected Attributes | |
|---|---|
| TInt | iCurrentStep |
| TFormatMode | iMode |
| TSpecialFormatInfoBuf | iSpecialInfo |
| Private Attributes | |
|---|---|
| CFormatCBBody * | iBody |
| TDrive * | iDrive |
| CMountCB * | iMount |
| void | DoFormatStepL | ( | ) | [pure virtual] |
Performs a formatting step on the drive.
The step performed should depend on the values of iMode and iCurrentStep.
It can be assumed that there are no resources open on the mount, that the media is formattable, and that the media is not write protected.
If iMode == EQuickFormat, then only meta data is to be written. This should be carried out in a single step, with iCurrentStep set to zero on completion.
If iMode != EQuickFormat, then the format step performed by this function should depend on iCurrentStep. When the function returns with iCurrentStep set to zero, the formatting of the drive is complete.
On error detection, the function should leave with an appropriate error code.
| TDrive & | Drive | ( | ) | const [inline] |
Gets the object representing the drive on which the disk to be formatted resides.
| IMPORT_C TInt | GetInterface | ( | TInt | aInterfaceId, |
| TAny *& | aInterface, | |||
| TAny * | aInput | |||
| ) | [protected, virtual] | |||
Return a pointer to a specified interface extension - to allow future extension of this class without breaking binary compatibility.
| void | InitL | ( | TDrive * | aDrive, |
| TFormatMode | aMode | |||
| ) | ||||
| TDrive * aDrive | |
| TFormatMode aMode |
| CMountCB & | Mount | ( | ) | const [inline] |
Gets the object representing the mount on which the disk to be formatted resides.
| void | SetFormatParameters | ( | const TLDFormatInfo * | apLDFormatInfo | ) |
| const TLDFormatInfo * apLDFormatInfo |
| TInt | SetFormatParameters | ( | const TVolFormatParam * | apVolFormatParam | ) |
| const TVolFormatParam * apVolFormatParam |
Enumeration of the aInterfaceIDs used in GetInterface
| ESetFmtParameters = 1 |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.