| class RFormat : public RSubSessionBase |
| Public Member Functions | |
|---|---|
| IMPORT_C void | Close() |
| IMPORT_C TInt | Next(TInt &) |
| IMPORT_C void | Next(TPckgBuf< TInt > &, TRequestStatus &) |
| IMPORT_C TInt | Open(RFs &, const TDesC &, TUint, TInt &) |
| IMPORT_C TInt | Open(RFs &, const TDesC &, TUint, TInt &, const TDesC8 &) |
| IMPORT_C void | Close | ( | ) |
Closes the Format subsession.
Any open files are closed when the file server session is closed.
Close() is guaranteed to return, and provides no indication whether it completed successfully or not.
| IMPORT_C TInt | Next | ( | TInt & | aStep | ) |
Executes the next format step.
This is a synchronous function, which returns when the formatting step is complete.
| TInt & aStep | The step number. On return, it is decremented to indicate what stage the formatting has reached. Before the first call to this function, this value is seeded with the number of tracks remaining to be formatted as returned by RFormat::Open(). The function should be called repeatedly until aStep reaches zero. |
| IMPORT_C void | Next | ( | TPckgBuf< TInt > & | aStep, |
| TRequestStatus & | aStatus | |||
| ) | ||||
| TPckgBuf< TInt > & aStep | The step number. On return, it is decremented to indicate what stage the formatting has reached. Before the first call to this function, this value is seeded with the number of tracks remaining to be formatted as returned by RFormat::Open(). The function should be called repeatedly until aStep reaches zero. |
| TRequestStatus & aStatus | The request status. On request completion, contains a completion code: KErrNone, if successful, otherwise one of the other system-wide error codes. |
| IMPORT_C TInt | Open | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFormatMode, | |||
| TInt & | aCount | |||
| ) | ||||
Opens a device for formatting.
The device may be formatted either at high or low density.
Devices which support read-only media may not be formatted. This includes the ROM on drive Z:. All files on the drive must be closed otherwise an error is returned.
| RFs & aFs | The file server session. Must be connected. |
| const TDesC & aName | The drive to be formatted, specified as a drive letter followed by a colon. |
| TUint aFormatMode | The format mode. See TFormatMode. |
| TInt & aCount | On successful return, contains the number of tracks which remain to be formatted. This value is passed to the first iteration of Next(), which then decrements the value on this and subsequent calls to Next(). |
| IMPORT_C TInt | Open | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFormatMode, | |||
| TInt & | aCount, | |||
| const TDesC8 & | anInfo | |||
| ) | ||||
Opens a device for formatting. User can specify new format parameters by anInfo.
The device may be formatted either at high or low density.
Devices which support read-only media may not be formatted. This includes the ROM on drive Z:. All files on the drive must be closed otherwise an error is returned.
| RFs & aFs | The file server session. Must be connected. |
| const TDesC & aName | The drive to be formatted, specified as a drive letter followed by a colon. |
| TUint aFormatMode | The format mode. See TFormatMode. |
| TInt & aCount | On successful return, contains the number of tracks which remain to be formatted. This value is passed to the first iteration of Next(), which then decrements the value on this and subsequent calls to Next(). |
| const TDesC8 & anInfo | Special format information specified by user. |
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.