| class RStoreWriteStream : public RWriteStream |
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
| 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) |
| RStoreWriteStream | ( | ) | [inline] |
Constructs an uninitialised object. It is necessary because there are also non-default constructors in this class.
| RStoreWriteStream | ( | const MExternalizer< TStreamRef > & | anExter | ) | [inline] |
Constructs an object with an externaliser. The store map CStoreMap is an example of an externalizer.
| const MExternalizer< TStreamRef > & anExter | Specifies an externaliser |
| 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.
RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore CPermanentFileStore
| CStreamStore & aStore | A reference to the store containing the stream. |
| TStreamId anId | The id of the stream to be appended. |
| 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.
RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore CPermanentFileStore
| CStreamStore & aStore | A reference to the store containing the stream. |
| TStreamId anId | The id of the stream to be appended. |
| 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.
| CStreamStore & aStore | A reference to the store which is to contain the new stream. |
| 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.
| CStreamStore & aStore | A reference to the store which is to contain the new stream. |
| 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.
RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore
| CStreamStore & aStore | A reference to the store containing the stream. |
| TStreamId anId | The id of the stream to be overwritten. |
| 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.
RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore
| CStreamStore & aStore | A reference to the store containing the stream. |
| TStreamId anId | The id of the stream to be overwritten. |
| 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.
RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore
| CStreamStore & aStore | A reference to the store containing the stream. |
| TStreamId anId | The id of the stream to be replaced. |
| 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.
RWriteStream::Release() RWriteStream::CommitL() CDirectFileStore
| CStreamStore & aStore | A reference to the store containing the stream. |
| TStreamId anId | The id of the stream to be replaced. |
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.