MMsvAttachmentManagerSync Class Reference

#include <mw/mmsvattachmentmanagersync.h>

class MMsvAttachmentManagerSync
Public Member Functions
pure virtual voidCreateAttachmentL(const TDesC &, RFile &, CMsvAttachment *)
pure virtual voidModifyAttachmentInfoL(CMsvAttachment *)
pure virtual voidRemoveAttachmentL(TInt)
pure virtual voidRenameAttachmentL(TInt, const TDesC &)

Detailed Description

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.

See also: CMsvAttachment

Member Function Documentation

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

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

Parameters
aFileNameThe filename to assign to the newly create attachment file.
aAttachmentFileAn 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.
aAttachmentInfoThe 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.
Leave Codes
KErrAccessDeniedIf attachment manager is in read-only mode.

ModifyAttachmentInfoL ( CMsvAttachment * )

voidModifyAttachmentInfoL(CMsvAttachment *aAttachmentInfo)[pure virtual]
Modify existing attachment
Parameters
aAttachmentInfoThe 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.
Leave Codes
KErrAccessDeniedIf attachment manager is in read-only mode.

RemoveAttachmentL ( TInt )

voidRemoveAttachmentL(TIntaIndex)[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 Codes
KErrAccessDeniedIf attachment manager is in read-only mode.

RenameAttachmentL ( TInt, const TDesC & )

voidRenameAttachmentL(TIntaIndex,
const TDesC &aNewName
)[pure virtual]

Renames the physical filename of an attachment.

Parameters
aIndexThe array index position of the attachment to be renamed.
aNewNameThe new name of the attachment.
Leave Codes
KErrAccessDeniedIf attachment manager is in read-only mode.
KErrAlreadyExistsIf the supplied attachment filename already exists.