#include <mmsvattachmentmanagersync.h>
Class MMsvAttachmentManagerSync
class MMsvAttachmentManagerSync;
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.
Members
Defined in MMsvAttachmentManagerSync
:
See also:
CMsvAttachment
Represents a single attachment and information about the attachment.
Member functions
CreateAttachmentL(const TDesC &,RFile &,CMsvAttachment *)
virtual void CreateAttachmentL(const TDesC &aFileName, RFile &aAttachmentFile, CMsvAttachment *aAttachmentInfo)=0;
Description
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
const TDesC16 &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.
|
|
Leave codes
KErrAccessDenied |
If attachment manager is in read-only mode.
|
|
RenameAttachmentL(TInt,const TDesC &)
virtual void RenameAttachmentL(TInt aIndex, const TDesC &aNewName)=0;
Description
Renames the physical filename of an attachment.
Parameters
TInt aIndex |
The array index position of the attachment to be renamed.
|
const TDesC16 &aNewName |
The new name of the attachment.
|
|
Leave codes
KErrAccessDenied |
If attachment manager is in read-only mode.
|
KErrAlreadyExists |
If the supplied attachment filename already exists.
|
|
virtual void RemoveAttachmentL(TInt aIndex)=0;
Description
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.
Parameters
Leave codes
KErrAccessDenied |
If attachment manager is in read-only mode.
|
|
ModifyAttachmentInfoL(CMsvAttachment *)
virtual void ModifyAttachmentInfoL(CMsvAttachment *aAttachmentInfo)=0;
Description
Modify existing attachment
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.
|
|
Leave codes
KErrAccessDenied |
If attachment manager is in read-only mode.
|
|