![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
CBase |
Abstract: CBase behaviour |
msvstore.h
ment.lib
This class provides an interface over the message store that is associated with a message entry. It is similar to the dictionary store in supporting the concept of streams referenced by UID.
This class is intended for use by MTM implementations. Message client applications access the store through the higher-level functions provided by Client-side and User Interface MTMs.
A CMsvStore object is created by a CMsvEntry object (see Message store access) and passed to a client process. The client process then becomes responsible for deleting the CMsvStore object. The store can be opened in two modes, read or edit, and only one CMsvStore object can have edit access to a store.
CMsvStore provides functions for general manipulation of the store, and for accessing the standard body text stream. RMsvReadStream and RMsvWriteStream must be used to access other streams.
~CMsvStore();
If the message store is currently locked, the destructor releases it before deleting the object.
void DeleteBodyTextL();
Use this function to deletes the stream that contains the body text. Write access is needed for this function.
KErrAccessDenied |
Store is not open for writing |
Other |
Standard streaming leave codes |
TBool HasBodyTextL() const;
Use this function to check if the store has a body text stream.
TBool |
ETrue if the store has a body text stream, else EFalse |
void RestoreBodyTextL(CRichText& aRichTextBody) const;
Use this function to read the body text stream from the message store into the given rich text object.
CRichText& aRichTextBody |
On return, the message stores body text is inserted into this object. Any previously existing contents is lost. |
KErrNotFound |
There is no body text stream in the store |
Other |
Standard streaming leave codes |
void StoreBodyTextL(const CRichText& aRichTextBody);
Use this function to store and commit aRichTextBody in the body text stream of the message store. Any existing data is overwritten. Write access is needed for this function.
const CRichText& aRichTextBody |
The body data to be externalised |
KErrAccessDenied |
Store is not open for writing |
Other |
Standard streaming leave codes |
Use these functions to commit changes to the message store. Committing changes makes these changes permanent, and means that the store cannot be rolled back to a state before the changes were begun. See Commit and revert for a full explanation of the commit-revert model in EPOC.
You should use these functions before deleting a CMsvStore, if you have made changes to it through RMsvWriteStream . Note that StoreBodyTextL() performs a commit itself, so an additional commit is not required after its use.
The two functions are identical, except that the Commit() returns any error code, while CommitL() leaves with the error code if an error occurs.
Write access is needed for these functions.
TInt Commit();
Use this function to commit changes to the message store, returning any error code.
KErrNone |
Changes committed successfully |
KErrAccessDenied |
Store open for read only |
Standard streaming error codes |
Unable to commit changes |
void CommitL();
Use this function to commit changes to the message store, leaving if an error occurs.
KErrAccessDenied |
Store open for read only |
Standard streaming error codes |
Unable to commit changes |
void DeleteL();
Use this function to delete the message store. After a delete, the behaviour of the object is undefined: it can only be deleted.
Write access is needed for this function.
KErrAccessDenied |
The store is read only |
Other |
Standard file store error codes |
TBool IsNullL() const;
Use this function to determine whether the message store contains any streams.
TBool |
ETrue if the store has no streams, else EFalse |
TBool IsPresentL(TUid aUid) const;
Use this function to determine whether the message store contains a stream identified by the aUid.
TUid aUid |
Identifier of stream |
TBool |
ETrue if the store has a stream aUid, else EFalse |
void Remove(TUid aUid);
Use this function to delete the stream identified by aUid from the store. The function returns, whether or not it completes successfully.
Write access is needed for this function.
TUid aUid |
The UID of the stream to delete |
void RemoveL(TUid aUid);
Use this function to delete the stream identified by aUid from the store. It leaves if it cannot complete successfully.
Write access is needed for this function.
TUid aUid |
The UID of the stream to delete |
KErrAccessDenied |
The store is read only |
Other |
Standard streaming error codes |
void Revert();
Use this function to revert the store to the previous commit level. This removes all changes that have been made to the store since the last commit. See Commit and revert for a full explanation of the commit-revert model in EPOC.
The function cannot leave: it returns, whether or not it completes successfully.
Write access is needed for this function.
void RevertL();
Use this function to revert the store to the previous commit level. This removes all changes that have been made to the store since the last commit. See Commit and revert for a full explanation of the commit-revert model in EPOC.
The function leaves if it cannot complete successfully.
Write access is needed for this function.
KErrAccessDenied |
The store is read only |
Other |
Standard streaming error codes |
TInt SizeL();
Use this function to get the size of the message store.
TInt |
Size of the message store in bytes |
Standard file store error codes
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |