CMsvStore Class Reference

class CMsvStore : public CBase

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

Inherits from

CMsvStore
- CBase

Public Member Functions
	~CMsvStore()
IMPORT_C MMsvAttachmentManagerSync &	AttachmentManagerExtensionsL()
IMPORT_C MMsvAttachmentManager &	AttachmentManagerL()
IMPORT_C TInt	Commit()
IMPORT_C void	CommitL()
IMPORT_C void	CreateShareProtectedAttachmentL(const TDesC &, RFile &, CMsvAttachment *)
IMPORT_C void	DeleteBodyTextL()
IMPORT_C void	DeleteL()
IMPORT_C TBool	HasBodyTextL()
IMPORT_C CMsvPlainBodyText *	InitialisePlainBodyTextForReadL(TInt)
IMPORT_C CMsvPlainBodyText *	InitialisePlainBodyTextForWriteL(TBool, TUint, TUint)
IMPORT_C TBool	IsNullL()
IMPORT_C TBool	IsPresentL(TUid)
IMPORT_C void	Remove(TUid)
IMPORT_C void	RemoveL(TUid)
void	Restore8BitBodyTextL(RFileReadStream &)
IMPORT_C void	RestoreBodyTextL(CRichText &)
IMPORT_C void	RestoreBodyTextL(CRichText &, TUint)
IMPORT_C void	Revert()
IMPORT_C void	RevertL()
IMPORT_C TInt	SizeL()
IMPORT_C void	StoreBodyTextL(const CRichText &)

Protected Member Functions
	CMsvStore(MMsvStoreObserver &, RFs &, TMsvId, MMsvStoreManager &)
IMPORT_C CMsvStore *	OpenForReadL(MMsvStoreObserver &, RFs &, MMsvStoreManager &, TMsvId)
IMPORT_C CMsvStore *	OpenForWriteL(MMsvStoreObserver &, RFs &, MMsvStoreManager &, TMsvId)

Private Member Functions
void	ConstructL(TBool)
void	Convert8BitToRichTextL(RFile &, CRichText &, TUint, TUint)
void	GetRichTextFrom16BitL(RFile &, CRichText &)
void	GetRichTextFrom8BitL(RFile &, CRichText &, TUint, TUint)
void	Lock()
void	RestorePlainBodyTextL(CRichText &, TUint)
const CMsvCachedStore &	Store()
CMsvCachedStore &	Store()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CMsvAttachmentManager *	iAttachmentManager
CMsvBodyText *	iBodyText
TBool	iConstructed
RFs &	iFs
const TMsvId	iId
enum CMsvStore::@52	iLockStatus
MMsvStoreObserver &	iObserver
CMsvCachedStore *	iStore
MMsvStoreManager &	iStoreManager

Constructor & Destructor Documentation

CMsvStore(MMsvStoreObserver &, RFs &, TMsvId, MMsvStoreManager &)

IMPORT_C	CMsvStore	(	MMsvStoreObserver &	aObserver,
			RFs &	aFs,
			TMsvId	aId,
			MMsvStoreManager &	aStoreManager
		)	[protected]

Parameters

MMsvStoreObserver & aObserver
RFs & aFs
TMsvId aId
MMsvStoreManager & aStoreManager

~CMsvStore()

IMPORT_C

~CMsvStore

(

)

Member Functions Documentation

AttachmentManagerExtensionsL()

IMPORT_C MMsvAttachmentManagerSync &

AttachmentManagerExtensionsL

(

)

AttachmentManagerL()

IMPORT_C MMsvAttachmentManager &

AttachmentManagerL

(

)

Commit()

IMPORT_C TInt

Commit

(

)

CommitL()

IMPORT_C void

CommitL

(

)

ConstructL(TBool)

void

ConstructL

(

TBool

aReadOnly

)

[private]

Parameters

TBool aReadOnly

Convert8BitToRichTextL(RFile &, CRichText &, TUint, TUint)

void	Convert8BitToRichTextL	(	RFile &	aBodyTextFile,
			CRichText &	aRichText,
			TUint	aCharSet,
			TUint	aDefaultCharSet
		)	[private]

Parameters

RFile & aBodyTextFile
CRichText & aRichText
TUint aCharSet
TUint aDefaultCharSet

CreateShareProtectedAttachmentL(const TDesC &, RFile &, CMsvAttachment *)

IMPORT_C void	CreateShareProtectedAttachmentL	(	const TDesC &	aFileName,
			RFile &	aAttachmentFile,
			CMsvAttachment *	aAttachmentInfo
		)

Parameters

const TDesC & aFileName
RFile & aAttachmentFile
CMsvAttachment * aAttachmentInfo

DeleteBodyTextL()

IMPORT_C void

DeleteBodyTextL

(

)

DeleteL()

IMPORT_C void

DeleteL

(

)

GetRichTextFrom16BitL(RFile &, CRichText &)

void	GetRichTextFrom16BitL	(	RFile &	aBodyTextFile,
			CRichText &	aRichText
		)	[private]

Parameters

RFile & aBodyTextFile
CRichText & aRichText

GetRichTextFrom8BitL(RFile &, CRichText &, TUint, TUint)

void	GetRichTextFrom8BitL	(	RFile &	aBodyTextFile,
			CRichText &	aRichText,
			TUint	aCharSet,
			TUint	aDefaultCharSet
		)	[private]

Parameters

RFile & aBodyTextFile
CRichText & aRichText
TUint aCharSet
TUint aDefaultCharSet

HasBodyTextL()

IMPORT_C TBool

HasBodyTextL

(

)

const

InitialisePlainBodyTextForReadL(TInt)

IMPORT_C CMsvPlainBodyText *

InitialisePlainBodyTextForReadL

(

TInt

aChunkLength

)

Parameters

TInt aChunkLength

InitialisePlainBodyTextForWriteL(TBool, TUint, TUint)

IMPORT_C CMsvPlainBodyText *	InitialisePlainBodyTextForWriteL	(	TBool	aIs8Bit,
			TUint	aCharsetId,
			TUint	aDefaultCharsetId
		)

Parameters

TBool aIs8Bit
TUint aCharsetId
TUint aDefaultCharsetId

IsNullL()

IMPORT_C TBool

IsNullL

(

)

const

IsPresentL(TUid)

IMPORT_C TBool

IsPresentL

(

TUid

aUid

)

const

Parameters

TUid aUid

Lock()

void

Lock

(

)

[private]

OpenForReadL(MMsvStoreObserver &, RFs &, MMsvStoreManager &, TMsvId)

IMPORT_C CMsvStore *	OpenForReadL	(	MMsvStoreObserver &	aObserver,
			RFs &	aFs,
			MMsvStoreManager &	aStoreManager,
			TMsvId	aId
		)	[protected, static]

Parameters

MMsvStoreObserver & aObserver
RFs & aFs
MMsvStoreManager & aStoreManager
TMsvId aId

OpenForWriteL(MMsvStoreObserver &, RFs &, MMsvStoreManager &, TMsvId)

IMPORT_C CMsvStore *	OpenForWriteL	(	MMsvStoreObserver &	aObserver,
			RFs &	aFs,
			MMsvStoreManager &	aStoreManager,
			TMsvId	aId
		)	[protected, static]

Parameters

MMsvStoreObserver & aObserver
RFs & aFs
MMsvStoreManager & aStoreManager
TMsvId aId

Remove(TUid)

IMPORT_C void

Remove

(

TUid

aUid

)

Parameters

TUid aUid

RemoveL(TUid)

IMPORT_C void

RemoveL

(

TUid

aUid

)

Parameters

TUid aUid

Restore8BitBodyTextL(RFileReadStream &)

void

Restore8BitBodyTextL

(

RFileReadStream &

aInputStream

)

Parameters

RFileReadStream & aInputStream

RestoreBodyTextL(CRichText &)

IMPORT_C void

RestoreBodyTextL

(

CRichText &

aRichTextBody

)

Parameters

CRichText & aRichTextBody

RestoreBodyTextL(CRichText &, TUint)

IMPORT_C void	RestoreBodyTextL	(	CRichText &	aRichTextBody,
			TUint	aCharsetOverride
		)

Parameters

CRichText & aRichTextBody
TUint aCharsetOverride

RestorePlainBodyTextL(CRichText &, TUint)

void	RestorePlainBodyTextL	(	CRichText &	aRichText,
			TUint	aCharsetOverride
		)	[private]

Parameters

CRichText & aRichText
TUint aCharsetOverride

Revert()

IMPORT_C void

Revert

(

)

RevertL()

IMPORT_C void

RevertL

(

)

SizeL()

IMPORT_C TInt

SizeL

(

)

Store()

const CMsvCachedStore &

Store

(

)

const [private, inline]

Store()

CMsvCachedStore &

Store

(

)

[private, inline]

StoreBodyTextL(const CRichText &)

IMPORT_C void

StoreBodyTextL

(

const CRichText &

aRichTextBody

)

Parameters

const CRichText & aRichTextBody

Member Data Documentation

CMsvAttachmentManager * iAttachmentManager

CMsvAttachmentManager *

iAttachmentManager

[private]

CMsvBodyText * iBodyText

CMsvBodyText *

iBodyText

[private]

TBool iConstructed

TBool

iConstructed

[private]

RFs & iFs

RFs &

iFs

[private]

const TMsvId iId

const TMsvId

iId

[private]

enum CMsvStore::@52 iLockStatus

enum CMsvStore::@52

iLockStatus

[private]

MMsvStoreObserver & iObserver

MMsvStoreObserver &

iObserver

[private]

CMsvCachedStore * iStore

CMsvCachedStore *

iStore

[private]

MMsvStoreManager & iStoreManager

MMsvStoreManager &

iStoreManager

[private]