Formats a device, one step at a time. More...
#include <f32file.h>
Public Member Functions | |
| IMPORT_C TInt | Open (RFs &aFs, const TDesC &aName, TUint aFormatMode, TInt &aCount) |
| Opens a device for formatting. | |
| IMPORT_C TInt | Open (RFs &aFs, const TDesC &aName, TUint aFormatMode, TInt &aCount, const TDesC8 &anInfo) |
| Opens a device for formatting. | |
| IMPORT_C void | Close () |
| Closes the Format subsession. | |
| IMPORT_C TInt | Next (TInt &aStep) |
| Executes the next format step. | |
| IMPORT_C void | Next (TPckgBuf< TInt > &aStep, TRequestStatus &aStatus) |
| Executes the next format step. | |
 Public Member Functions inherited from RSubSessionBase | |
| TInt | SubSessionHandle () const |
| Gets the sub-session handle number. | |
Additional Inherited Members | |
| Protected Member Functions inherited from RSubSessionBase | |
| RSubSessionBase () | |
| Default constructor. | |
| IMPORT_C const RSessionBase | Session () const |
| Returns a copy of the session associated with this sub-session. | |
| TInt | CreateSubSession (const RSessionBase &aSession, TInt aFunction, const TIpcArgs &aArgs) |
| Creates a new sub-session within an existing session. | |
| TInt | CreateSubSession (const RSessionBase &aSession, TInt aFunction) |
| Creates a new sub-session within an existing session. | |
| IMPORT_C TInt | CreateAutoCloseSubSession (RSessionBase &aSession, TInt aFunction, const TIpcArgs &aArgs) |
| Creates a new sub-session within an existing session. | |
| IMPORT_C void | CloseSubSession (TInt aFunction) |
| Closes the sub-session. | |
| TInt | Send (TInt aFunction, const TIpcArgs &aArgs) const |
| Sends a blind message to the server - no reply is expected. | |
| void | SendReceive (TInt aFunction, const TIpcArgs &aArgs, TRequestStatus &aStatus) const |
| Sends a message to the server and waits asynchronously for the reply. | |
| TInt | SendReceive (TInt aFunction, const TIpcArgs &aArgs) const |
| Sends a message to the server and waits synchronously for a reply. | |
| TInt | Send (TInt aFunction) const |
| Sends a blind message to the server - no reply is expected. | |
| void | SendReceive (TInt aFunction, TRequestStatus &aStatus) const |
| Sends a message to the server and waits asynchronously for the reply. | |
| TInt | SendReceive (TInt aFunction) const |
| Sends a message to the server and waits synchronously for a reply. | |
Detailed Description
Formats a device, one step at a time.
RFormat must first be opened on a device before formatting each track using Next().
There is also an asynchronous version of Next() which, if encapsulated into a suitable active object, can be used to implement a user-interruptible formatting process.
- API status
- Published to all clients. Released API.
Member Function Documentation
◆ Close()
| IMPORT_C void RFormat::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.
(generated from Symbian Developer Library)
◆ Next() [1/2]
| IMPORT_C TInt RFormat::Next | ( | TInt & | aStep | ) |
Executes the next format step.
This is a synchronous function, which returns when the formatting step is complete.
- Parameters
-
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.
- capability
- DiskAdmin
(generated from Symbian Developer Library)
◆ Next() [2/2]
| IMPORT_C void RFormat::Next | ( | TPckgBuf< TInt > & | aStep, |
| TRequestStatus & | aStatus | ||
| ) |
Executes the next format step.
This is an asynchronous function.
- Parameters
-
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. aStatus The request status. On request completion, contains a completion code: KErrNone, if successful, otherwise one of the other system-wide error codes.
- capability
- DiskAdmin
(generated from Symbian Developer Library)
◆ Open() [1/2]
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.
- Parameters
-
aFs The file server session. Must be connected. aName The drive to be formatted, specified as a drive letter followed by a colon. aFormatMode The format mode. See TFormatMode. 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().
- capability
- DiskAdmin
(generated from Symbian Developer Library)
◆ Open() [2/2]
| IMPORT_C TInt RFormat::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.
- Parameters
-
aFs The file server session. Must be connected. aName The drive to be formatted, specified as a drive letter followed by a colon. aFormatMode The format mode. See TFormatMode. 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(). anInfo Special format information specified by user.
- capability
- DiskAdmin
(generated from Symbian Developer Library)
The documentation for this class was generated from the following files:
