1.1 --- a/epoc32/include/mmsvattachmentmanagersync.h Tue Mar 16 16:12:26 2010 +0000
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,94 +0,0 @@
1.4 -// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 -// All rights reserved.
1.6 -// This component and the accompanying materials are made available
1.7 -// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 -// which accompanies this distribution, and is available
1.9 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 -//
1.11 -// Initial Contributors:
1.12 -// Nokia Corporation - initial contribution.
1.13 -//
1.14 -// Contributors:
1.15 -//
1.16 -// Description:
1.17 -//
1.18 -
1.19 -#ifndef __MMSVATTACHMENTMANAGERSYNC_H__
1.20 -#define __MMSVATTACHMENTMANAGERSYNC_H__
1.21 -
1.22 -#include <e32base.h>
1.23 -#include <msvstd.h>
1.24 -#include <cmsvattachment.h>
1.25 -
1.26 -class MMsvAttachmentManagerSync
1.27 -/**
1.28 -Defines the attachment management extensions interface.
1.29 -
1.30 -This class is a pure virtual interface class that defines the APIs to be used for
1.31 -by MTMs and implementors of MMsvAttachmentManager.
1.32 -
1.33 -This API extends the MMsvAttachmentManager with synchronous calls for deleting
1.34 -and creating attachments.
1.35 -
1.36 -@see CMsvAttachment
1.37 -@publishedAll
1.38 -@released
1.39 -*/
1.40 - {
1.41 -public:
1.42 - /**
1.43 - Creates a new empty attachment file.
1.44 -
1.45 - The caller is returned an open writable file handle to an empty attachment file in the message
1.46 - store. The caller must pass in an uninitialised file handle. If the request is sucessful the file handle
1.47 - is open and must close by the caller once the data has been written to it.
1.48 -
1.49 - @param aFileName The filename to assign to the newly create attachment file.
1.50 - @param aAttachmentFile An uninitialised file handle. This is opened and can be written to if the
1.51 - request is successful. The ownership is transferred . The caller must close the file handle.
1.52 - @param aAttachmentInfo The attachment info associated with the file.
1.53 - If the routine does not leave, then ownership will be transferred to the
1.54 - attachment manager. If the routine does leave then ownership will not have
1.55 - been transfered and the caller is responsible for cleanup.
1.56 - @leave KErrAccessDenied If attachment manager is in read-only mode.
1.57 - */
1.58 - virtual void CreateAttachmentL(const TDesC& aFileName, RFile& aAttachmentFile, CMsvAttachment* aAttachmentInfo) = 0;
1.59 -
1.60 -
1.61 -
1.62 - /**
1.63 - Renames the physical filename of an attachment.
1.64 -
1.65 - @param aIndex The array index position of the attachment to be renamed.
1.66 - @param aNewName The new name of the attachment.
1.67 - @leave KErrAccessDenied If attachment manager is in read-only mode.
1.68 - @leave KErrAlreadyExists If the supplied attachment filename already exists.
1.69 - */
1.70 - virtual void RenameAttachmentL(TInt aIndex, const TDesC& aNewName) = 0;
1.71 -
1.72 -
1.73 - /**
1.74 - Removes the attachment from the message entry.
1.75 -
1.76 - This changes the array index values of all the attachments after the removed one.
1.77 - Attachment files stored in the message store are deleted. Linked files and message entry
1.78 - attachments are not deleted, this is left to the caller to do if required.
1.79 -
1.80 - @param aParam The array index position of the attachment to be removed.
1.81 - @leave KErrAccessDenied If attachment manager is in read-only mode.
1.82 - */
1.83 - virtual void RemoveAttachmentL(TInt aIndex) = 0;
1.84 -
1.85 - /**
1.86 - Modify existing attachment
1.87 - @param aAttachmentInfo The attachment info associated with the file.
1.88 - If the routine does not leave, then ownership will be transferred to the
1.89 - attachment manager. If the routine does leave then ownership will not have
1.90 - been transfered and the caller is responsible for cleanup.
1.91 - @leave KErrAccessDenied If attachment manager is in read-only mode.
1.92 - */
1.93 - virtual void ModifyAttachmentInfoL(CMsvAttachment* aAttachmentInfo) = 0;
1.94 -
1.95 - };
1.96 -
1.97 -#endif // __MMSVATTACHMENTMANAGERSYNC_H__