Collapse all Symbian^3 Product Developer Library

RFileWriteStream Class Reference

class RFileWriteStream : public RWriteStream

Supports the writing of a stream to a file.

Inherits from

RFileWriteStream
- RWriteStream

Public Member Functions
	RFileWriteStream()
	RFileWriteStream(const MExternalizer< TStreamRef > &)
	RFileWriteStream(RFile &, TInt)
IMPORT_C void	Attach(RFile &, TInt)
IMPORT_C TInt	Open(RFs &, const TDesC &, TUint)
IMPORT_C TInt	Replace(RFs &, const TDesC &, TUint)
IMPORT_C TInt	Temp(RFs &, const TDesC &, TFileName &, TUint)

Inherited Functions
	RWriteStream::Attach(MStreamBuf *)
	RWriteStream::Close()
	RWriteStream::CommitL()
	RWriteStream::Detach()
	RWriteStream::Pop()
	RWriteStream::PushL()
	RWriteStream::RWriteStream()
	RWriteStream::RWriteStream(MStreamBuf *)
	RWriteStream::RWriteStream(const MExternalizer< TStreamRef > &)
	RWriteStream::Release()
	RWriteStream::Sink()
	RWriteStream::WriteInt16L(TInt)
	RWriteStream::WriteInt32L(TInt32)
	RWriteStream::WriteInt8L(TInt)
	RWriteStream::WriteL(RReadStream &)
	RWriteStream::WriteL(RReadStream &,TInt)
	RWriteStream::WriteL(const TDesC16 &)
	RWriteStream::WriteL(const TDesC16 &,TInt)
	RWriteStream::WriteL(const TDesC8 &)
	RWriteStream::WriteL(const TDesC8 &,TInt)
	RWriteStream::WriteL(const TUint16 *,TInt)
	RWriteStream::WriteL(const TUint8 *,TInt)
	RWriteStream::WriteReal32L(TReal)
	RWriteStream::WriteReal64L(TReal64)
	RWriteStream::WriteUint16L(TUint)
	RWriteStream::WriteUint32L(TUint32)
	RWriteStream::WriteUint8L(TUint)

Private Attributes
RFileBuf	iSink

Constructor & Destructor Documentation

RFileWriteStream()

RFileWriteStream

(

)

[inline]

Constructs an empty write stream object.

RFileWriteStream(const MExternalizer< TStreamRef > &)

RFileWriteStream

(

const MExternalizer< TStreamRef > &

anExter

)

[inline]

Parameters

const MExternalizer< TStreamRef > & anExter

RFileWriteStream(RFile &, TInt)

IMPORT_C	RFileWriteStream	(	RFile &	aFile,
			TInt	aPos = 0
		)

Constructs the write stream object, associates it with an already opened file, and prepares the stream for writing.

Parameters

RFile & aFile	A reference to the opened file.
TInt aPos = 0	The offset into the file where the stream is to be written. Defaults to zero.

Member Functions Documentation

Attach(RFile &, TInt)

IMPORT_C void	Attach	(	RFile &	aFile,
			TInt	aPos = 0
		)

Parameters

RFile & aFile
TInt aPos = 0

Open(RFs &, const TDesC &, TUint)

IMPORT_C TInt	Open	(	RFs &	aFs,
			const TDesC &	aName,
			TUint	aFileMode
		)

Parameters

RFs & aFs
const TDesC & aName
TUint aFileMode

Replace(RFs &, const TDesC &, TUint)

IMPORT_C TInt	Replace	(	RFs &	aFs,
			const TDesC &	aName,
			TUint	aFileMode
		)

Creates a new file, associates the file with this stream, and prepares the stream for writing.

The file replaces any existing file of the same name.

The stream will be written to offset zero in the file.

TFileMode

Parameters

RFs & aFs	Handle to a file server session.
const TDesC & aName	The full path name of the file.
TUint aFileMode	The mode in which the file is to be accessed. The mode is defined by by the TFileMode type.

Temp(RFs &, const TDesC &, TFileName &, TUint)

IMPORT_C TInt	Temp	(	RFs &	aFs,
			const TDesC &	aPath,
			TFileName &	aName,
			TUint	aFileMode
		)

Creates a temporary file, associates it with this stream, and prepares the stream for writing.

The new file is created in the specified path and a unique file name is generated by the file server.

Note that the store framework does not delete a temporary file after it is closed.

The stream will be written to offset zero in the file.

TFileMode

Parameters

RFs & aFs	Handle to a file server session.
const TDesC & aPath	The path where the new file is to be created.
TFileName & aName	On return, contains the full path name of the new file.
TUint aFileMode	The mode in which the file is to be accessed. The mode is defined by by the TFileMode type.

Member Data Documentation

RFileBuf iSink

RFileBuf

iSink

[private]