RStoreWriteStream Class Reference

#include <s32std.h>

class RStoreWriteStream : public RWriteStream

Inherits from

RStoreWriteStream
- RWriteStream

Public Member Functions
	RStoreWriteStream()
	RStoreWriteStream(const MExternalizer< TStreamRef > &)
IMPORT_C void	AppendL(CStreamStore &, TStreamId)
IMPORT_C void	AppendLC(CStreamStore &, TStreamId)
IMPORT_C TStreamId	CreateL(CStreamStore &)
IMPORT_C TStreamId	CreateLC(CStreamStore &)
IMPORT_C void	OpenL(CStreamStore &, TStreamId)
IMPORT_C void	OpenLC(CStreamStore &, TStreamId)
IMPORT_C void	ReplaceL(CStreamStore &, TStreamId)
IMPORT_C void	ReplaceLC(CStreamStore &, TStreamId)

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)

Detailed Description

Supports the writing of a stream to a store.

The class allows:

creation of a new stream

overwriting of an existing stream

replacement of an existing stream

appending to an existing stream

Constructor & Destructor Documentation

RStoreWriteStream ( )

RStoreWriteStream

(

)

[inline]

Constructs an uninitialised object. It is necessary because there are also non-default constructors in this class.

RStoreWriteStream ( const MExternalizer< TStreamRef > & )

RStoreWriteStream

(

const MExternalizer< TStreamRef > &

anExter

)

[inline]

Constructs an object with an externaliser. The store map CStoreMap is an example of an externalizer.

Parameters
anExter	Specifies an externaliser

Member Function Documentation

AppendL ( CStreamStore &, TStreamId )

IMPORT_C void	AppendL	(	CStreamStore &	aStore,
			TStreamId	anId
		)

Opens an existing stream and prepares it for appending.

The function leaves if it cannot complete successfully.

Note that a call to this function must be matched by a call to CommitL() before this object is disposed of.

See also: RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore CPermanentFileStore

Parameters
aStore	A reference to the store containing the stream.
anId	The id of the stream to be appended.

AppendLC ( CStreamStore &, TStreamId )

IMPORT_C void	AppendLC	(	CStreamStore &	aStore,
			TStreamId	anId
		)

Opens an existing stream, prepares it for appending, and puts a cleanup item onto the cleanup stack.

The function leaves if it cannot complete successfully.

Putting a cleanup item onto the cleanup stack allows allocated resources to be cleaned up if a subsequent leave occurs.

Note that call to this function must be matched by a call to CommitL() before the RStoreWriteStream object is disposed of.

See also: RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore CPermanentFileStore

Parameters
aStore	A reference to the store containing the stream.
anId	The id of the stream to be appended.

CreateL ( CStreamStore & )

IMPORT_C TStreamId

CreateL

(

CStreamStore &

aStore

)

Creates a new stream.

The function creates a new stream in the specified store and prepares the stream for writing. The function returns the new stream id, and leaves if it cannot complete successfully.

Note that a call to this function must be matched by a call to CommitL() before this object is disposed of.

Parameters
aStore	A reference to the store which is to contain the new stream.

Return Value: The stream id of the newly created stream.

CreateLC ( CStreamStore & )

IMPORT_C TStreamId

CreateLC

(

CStreamStore &

aStore

)

Creates a new stream, putting a cleanup item onto the cleanup stack.

The function creates a new stream in the specified store and prepares the stream for writing. The function returns the new stream id, and leaves if it cannot complete successfully.

Putting a cleanup item onto the cleanup stack allows allocated resources to be cleaned up if a subsequent leave occurs.

Note that a call to this function must be matched by a call to CommitL() before this object is disposed of.

Parameters
aStore	A reference to the store which is to contain the new stream.

Return Value: The stream id of the newly created stream.

OpenL ( CStreamStore &, TStreamId )

IMPORT_C void	OpenL	(	CStreamStore &	aStore,
			TStreamId	anId
		)

Opens an existing stream and prepares it for overwriting.

The function leaves if cannot complete successfully.

Note that a call to this function must be matched by a call to CommitL() before this object is disposed of.

See also: RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore

Parameters
aStore	A reference to the store containing the stream.
anId	The id of the stream to be overwritten.

OpenLC ( CStreamStore &, TStreamId )

IMPORT_C void	OpenLC	(	CStreamStore &	aStore,
			TStreamId	anId
		)

Opens an existing stream, prepares it for overwriting, and puts a cleanup item onto the cleanup stack.

The function leaves if cannot complete successfully.

Putting a cleanup item onto the cleanup stack allows allocated resources to be cleaned up if a subsequent leave occurs.

Note that a call to this function must be matched by a call to CommitL() before this object is disposed of.

See also: RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore

Parameters
aStore	A reference to the store containing the stream.
anId	The id of the stream to be overwritten.

ReplaceL ( CStreamStore &, TStreamId )

IMPORT_C void	ReplaceL	(	CStreamStore &	aStore,
			TStreamId	anId
		)

Opens an existing stream and prepares it for replacement.

The function leaves if it cannot complete successfully.

Note that a call to this function must be matched by a call to CommitL() before this object is disposed of.

See also: RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore

Parameters
aStore	A reference to the store containing the stream.
anId	The id of the stream to be replaced.

ReplaceLC ( CStreamStore &, TStreamId )

IMPORT_C void	ReplaceLC	(	CStreamStore &	aStore,
			TStreamId	anId
		)

Opens an existing stream, prepares it for replacement and puts a cleanup item onto the cleanup stack.

The function leaves if it cannot complete successfully.

Placing a cleanup item onto the cleanup stack allows allocated resources to be cleaned up if a subsequent leave occurs.

Note that a call to this function must be matched by a call to CommitL() before this object is disposed of.

See also: RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore

Parameters
aStore	A reference to the store containing the stream.
anId	The id of the stream to be replaced.