Collapse all Symbian^3 Application Developer Library

MMsvAttachmentManagerSync Class Reference

class MMsvAttachmentManagerSync

Defines the attachment management extensions interface.

This class is a pure virtual interface class that defines the APIs to be used for by MTMs and implementors of MMsvAttachmentManager .

This API extends the MMsvAttachmentManager with synchronous calls for deleting and creating attachments.

CMsvAttachment

Public Member Functions
void	CreateAttachmentL (const TDesC &, RFile &, CMsvAttachment *)
void	ModifyAttachmentInfoL ( CMsvAttachment *)
void	RemoveAttachmentL ( TInt )
void	RenameAttachmentL ( TInt , const TDesC &)

Member Functions Documentation

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

void	CreateAttachmentL	(	const TDesC &	aFileName,
			RFile &	aAttachmentFile,
			CMsvAttachment *	aAttachmentInfo
		)	[pure virtual]

Creates a new empty attachment file.

The caller is returned an open writable file handle to an empty attachment file in the message store. The caller must pass in an uninitialised file handle. If the request is sucessful the file handle is open and must close by the caller once the data has been written to it.

leave: KErrAccessDenied If attachment manager is in read-only mode.

Parameters

const TDesC & aFileName	The filename to assign to the newly create attachment file.
RFile & aAttachmentFile	An uninitialised file handle. This is opened and can be written to if the request is successful. The ownership is transferred . The caller must close the file handle.
CMsvAttachment * aAttachmentInfo	The attachment info associated with the file. If the routine does not leave, then ownership will be transferred to the attachment manager. If the routine does leave then ownership will not have been transfered and the caller is responsible for cleanup.

ModifyAttachmentInfoL(CMsvAttachment *)

void

ModifyAttachmentInfoL

(

CMsvAttachment *

aAttachmentInfo

)

[pure virtual]

Modify existing attachment

leave: KErrAccessDenied If attachment manager is in read-only mode.

Parameters

CMsvAttachment * aAttachmentInfo

The attachment info associated with the file. If the routine does not leave, then ownership will be transferred to the attachment manager. If the routine does leave then ownership will not have been transfered and the caller is responsible for cleanup.

RemoveAttachmentL(TInt)

void

RemoveAttachmentL

(

TInt

aIndex

)

[pure virtual]

Removes the attachment from the message entry.

This changes the array index values of all the attachments after the removed one. Attachment files stored in the message store are deleted. Linked files and message entry attachments are not deleted, this is left to the caller to do if required.

leave: KErrAccessDenied If attachment manager is in read-only mode.

Parameters

TInt aIndex

RenameAttachmentL(TInt, const TDesC &)

void	RenameAttachmentL	(	TInt	aIndex,
			const TDesC &	aNewName
		)	[pure virtual]

Renames the physical filename of an attachment.

leave: KErrAccessDenied If attachment manager is in read-only mode.

leave: KErrAlreadyExists If the supplied attachment filename already exists.

Parameters

TInt aIndex	The array index position of the attachment to be renamed.
const TDesC & aNewName	The new name of the attachment.