Collapse all Symbian^3 Product Developer Library

CMsgStorePropertyContainerWithContent Class Reference

class CMsgStorePropertyContainerWithContent : public CMsgStoreWritablePropertyContainer

This class adds the capability to store content to a property container.

This class adds the capability to store content with a set of name/value pairs. The content can be accessed via descriptor buffers or file handles. File handles are used in order to more easily transfer large data within a data-caged environment.

Inherits from

CMsgStorePropertyContainerWithContent
- CMsgStoreWritablePropertyContainer

Public Member Functions
IMPORT_C void	AppendToContentL(const TDesC8 &)
IMPORT_C TUint	ContentLengthL()
IMPORT_C const TDesC &	ContentTypeL()
IMPORT_C void	FetchContentToBufferL(TDes8 &, TUint)
IMPORT_C void	FetchContentToFileL(const TDesC &)
IMPORT_C void	OpenOriginalContentFileL(RFile &)
IMPORT_C void	PrependToContentL(const TDesC8 &)
IMPORT_C void	RemoveContentL()
IMPORT_C void	ReplaceContentL(const TDesC8 &)
IMPORT_C void	ReplaceContentWithFileL(const TDesC &)
IMPORT_C void	SetContentTypeL(const TDesC &)

Protected Member Functions
	CMsgStorePropertyContainerWithContent(CMsgStoreSessionContext &, TMsgStoreId, TMsgStoreId, TMsgStoreId)

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()
	CMsgStorePropertyContainer::AddOrUpdatePropertyL(const TDesC8 &,TBool)
	CMsgStorePropertyContainer::AddOrUpdatePropertyL(const TDesC8 &,TUint32)
	CMsgStorePropertyContainer::AddOrUpdatePropertyL(const TDesC8 &,const CMsgStorePropertyContainer &)
	CMsgStorePropertyContainer::AddOrUpdatePropertyL(const TDesC8 &,const RMsgStoreAddress &)
	CMsgStorePropertyContainer::AddOrUpdatePropertyL(const TDesC8 &,const TDesC &)
	CMsgStorePropertyContainer::AddOrUpdatePropertyL(const TDesC8 &,const TDesC8 &)
	CMsgStorePropertyContainer::AddOrUpdatePropertyL(const TDesC8 &,const TTime &)
	CMsgStorePropertyContainer::AddPropertyL(const TDesC8 &,TBool)
	CMsgStorePropertyContainer::AddPropertyL(const TDesC8 &,TUint32)
	CMsgStorePropertyContainer::AddPropertyL(const TDesC8 &,const CMsgStorePropertyContainer &)
	CMsgStorePropertyContainer::AddPropertyL(const TDesC8 &,const RMsgStoreAddress &)
	CMsgStorePropertyContainer::AddPropertyL(const TDesC8 &,const TDesC &)
	CMsgStorePropertyContainer::AddPropertyL(const TDesC8 &,const TDesC8 &)
	CMsgStorePropertyContainer::AddPropertyL(const TDesC8 &,const TTime &)
	CMsgStorePropertyContainer::CMsgStorePropertyContainer()
	CMsgStorePropertyContainer::DeserializeL(const TDesC8 &)
	CMsgStorePropertyContainer::FindProperty(const TDesC8 &,TUint &,TUint)const
	CMsgStorePropertyContainer::Id()const
	CMsgStorePropertyContainer::NewL()
	CMsgStorePropertyContainer::ParentId()const
	CMsgStorePropertyContainer::PropertyCount()const
	CMsgStorePropertyContainer::PropertyNameL(TUint)const
	CMsgStorePropertyContainer::PropertyTypeL(TUint)const
	CMsgStorePropertyContainer::PropertyValueAddressL(TUint,RMsgStoreAddress &)const
	CMsgStorePropertyContainer::PropertyValueBoolL(TUint)const
	CMsgStorePropertyContainer::PropertyValueContainerL(TUint)const
	CMsgStorePropertyContainer::PropertyValueDes8L(TUint)const
	CMsgStorePropertyContainer::PropertyValueDesL(TUint)const
	CMsgStorePropertyContainer::PropertyValueTimeL(TUint,TTime &)const
	CMsgStorePropertyContainer::PropertyValueUint32L(TUint)const
	CMsgStorePropertyContainer::RemovePropertyL(TUint)
	CMsgStorePropertyContainer::SerializeL(RBuf8 &)const
	CMsgStorePropertyContainer::SetIds(TMsgStoreId,TMsgStoreId)
	CMsgStorePropertyContainer::UpdatePropertyL(TUint,TBool)
	CMsgStorePropertyContainer::UpdatePropertyL(TUint,TUint32)
	CMsgStorePropertyContainer::UpdatePropertyL(TUint,const CMsgStorePropertyContainer &)
	CMsgStorePropertyContainer::UpdatePropertyL(TUint,const RMsgStoreAddress &)
	CMsgStorePropertyContainer::UpdatePropertyL(TUint,const TDesC &)
	CMsgStorePropertyContainer::UpdatePropertyL(TUint,const TDesC8 &)
	CMsgStorePropertyContainer::UpdatePropertyL(TUint,const TTime &)
	CMsgStorePropertyContainer::ValidateIndexL(TUint)const
	CMsgStorePropertyContainer::~CMsgStorePropertyContainer()
	CMsgStoreWritablePropertyContainer::CMsgStoreWritablePropertyContainer(CMsgStoreSessionContext &,TMsgStoreId,TMsgStoreId,TMsgStoreId)
	CMsgStoreWritablePropertyContainer::ConstructL(const TDesC8 &)
	CMsgStoreWritablePropertyContainer::NewL(CMsgStoreSessionContext &,TMsgStoreId,TMsgStoreId,TMsgStoreId,const TDesC8 &)
	CMsgStoreWritablePropertyContainer::StorePropertiesL()
	CMsgStoreWritablePropertyContainer::StorePropertyL(TUint)

Protected Attributes
TBool	iHasContent

Inherited Attributes
	CMsgStorePropertyContainer::iId
	CMsgStorePropertyContainer::iParentId
	CMsgStorePropertyContainer::iProperties
	CMsgStoreWritablePropertyContainer::iContext
	CMsgStoreWritablePropertyContainer::iMailBoxId

Constructor & Destructor Documentation

CMsgStorePropertyContainerWithContent(CMsgStoreSessionContext &, TMsgStoreId, TMsgStoreId, TMsgStoreId)

CMsgStorePropertyContainerWithContent	(	CMsgStoreSessionContext &	aSessionContext,
		TMsgStoreId	aId,
		TMsgStoreId	aParentId,
		TMsgStoreId	aMailBoxId
	)	[protected]

Parameters

CMsgStoreSessionContext & aSessionContext
TMsgStoreId aId
TMsgStoreId aParentId
TMsgStoreId aMailBoxId

Member Functions Documentation

AppendToContentL(const TDesC8 &)

IMPORT_C void

AppendToContentL

(

const TDesC8 &

aBuffer

)

Appends the given buffer to the content in the message store.

ECapabilityWriteUserData is required to use this function.

Parameters

const TDesC8 & aBuffer

ContentLengthL()

IMPORT_C TUint

ContentLengthL

(

)

Returns the length of the current content.

ContentTypeL()

IMPORT_C const TDesC &

ContentTypeL

(

)

Returns the type of the current content.

FetchContentToBufferL(TDes8 &, TUint)

IMPORT_C void	FetchContentToBufferL	(	TDes8 &	aBuffer,
			TUint	aStartOffset = 0
		)

Fetches the content into a buffer.

This function reads a portion or all of the content into a contiguous RAM buffer provided by the caller. The content will be will be truncated if the amount in local storage is larger than the given buffer.

ECapabilityReadUserData is required to use this function.

Parameters

TDes8 & aBuffer
TUint aStartOffset = 0

FetchContentToFileL(const TDesC &)

IMPORT_C void

FetchContentToFileL

(

const TDesC &

aFilename

)

Fetches the content into the designated file.

This function copies the entire content buffer into the given file. The given file is opened in the caller's process, so any file that is accessible by the caller can be used in this call (including private files).

ECapabilityReadUserData is required to use this function.

Parameters

const TDesC & aFilename

OpenOriginalContentFileL(RFile &)

IMPORT_C void

OpenOriginalContentFileL

(

RFile &

aFile

)

Opens the original content file and transfer the file handle to the provided RFile handle.

This method is intended to be used when the message store is NOT encrypted. It leaves with KErrNotSupported if the content is encrypted. The file will be opened with EFileRead and EFileShareAny ECapabilityReadUserData is required to use this function.

Parameters

RFile & aFile

PrependToContentL(const TDesC8 &)

IMPORT_C void

PrependToContentL

(

const TDesC8 &

aBuffer

)

Prepends the given buffer to the content in the message store.

ECapabilityWriteUserData is required to use this function.

Parameters

const TDesC8 & aBuffer

RemoveContentL()

IMPORT_C void

RemoveContentL

(

)

Wipes the contents of the content from local storage.

ECapabilityWriteUserData is required to use this function.

ReplaceContentL(const TDesC8 &)

IMPORT_C void

ReplaceContentL

(

const TDesC8 &

aBuffer

)

Replaces the current content with the given buffer.

ECapabilityWriteUserData is required to use this function.

Parameters

const TDesC8 & aBuffer

ReplaceContentWithFileL(const TDesC &)

IMPORT_C void

ReplaceContentWithFileL

(

const TDesC &

aFilename

)

Replaces the current content with the contents of the given file.

ECapabilityWriteUserData is required to use this function. The given file is opened in the caller's process, so any file that is accessible by the caller can be used in this call (including private files).

Parameters

const TDesC & aFilename

SetContentTypeL(const TDesC &)

IMPORT_C void

SetContentTypeL

(

const TDesC &

aType

)

Sets the type of the current content.

Parameters

const TDesC & aType

Member Data Documentation

TBool iHasContent

TBool

iHasContent

[protected]