RFormat Class Reference

#include <f32file.h>

class RFormat : public RSubSessionBase

Inherits from

RFormat

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 &)

Inherited Functions
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const

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.

Member Function Documentation

Close ( )

IMPORT_C void

(

)

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.

Next ( TInt & )

IMPORT_C TInt

(

TInt &

aStep

)

Executes the next format step.

This is a synchronous function, which returns when the formatting step is complete.

Parameter	Description
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.

Next ( TPckgBuf< TInt > &, TRequestStatus & )

IMPORT_C void	Next	(	TPckgBuf< TInt > &	aStep,
			TRequestStatus &	aStatus
		)

Executes the next format step.

This is an asynchronous function.

Parameter	Description
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.

Open ( RFs &, const TDesC &, TUint, TInt & )

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.

Parameter	Description
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().

Open ( RFs &, const TDesC &, TUint, TInt &, const TDesC8 & )

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.