Collapse all Symbian^3 Application Developer Library

CImPruneMessage Class Reference

class CImPruneMessage : public CMsgActive

Deletes the body text and attachment data from an individually specified message.

Example uses of this class are:

1. to cleanup after a populating operation has failed

2. to remove body text and attachment data from remote messages, while preserving the message structure

Inherits from

CImPruneMessage
- CMsgActive
  - CActive
    - CBase

Public Member Functions
	~CImPruneMessage ()
IMPORT_C CImPruneMessage *	NewL ( CMsvEntry &, RFs &)
IMPORT_C CImPruneMessage *	NewLC ( CMsvEntry &, RFs &)
IMPORT_C void	StartL ( TMsvId , TRequestStatus &)

Private Member Functions
	CImPruneMessage ( CMsvEntry &, RFs &)
void	ConstructL ()
void	DoCancel ()
void	DoComplete ( TInt &)
void	DoRunL ()
void	PruneEntryL ()
void	ResetStoreL ()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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()
	CMsgActive::CMsgActive(TInt)
	CMsgActive::Complete(TInt)
	CMsgActive::Queue(TRequestStatus &)
	CMsgActive::~CMsgActive()

Private Member Enumerations
enum	TImPruningState { EImPruneUpdatingEntry , EImPruneUpdatingFirstEntry , EImPruneFindingEntry , EImPruneFindFirstEntry , EImPruneFindNextEntry }

Inherited Enumerations
	CActive:TPriority

Private Attributes
CMsvOperation *	iChangeOperation
CMsvEntry &	iCurrentEntry
CImEntryFinder *	iEntryFinder
CFileMan *	iFileManager
RFs &	iFs
TMsvId	iRootEntryId
TImPruningState	iState
CMsvStore *	iStore

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CImPruneMessage(CMsvEntry &, RFs &)

CImPruneMessage	(	CMsvEntry &	aEntry,
		RFs &	aFs
	)	[private]

Parameters

CMsvEntry & aEntry
RFs & aFs

~CImPruneMessage()

~CImPruneMessage

(

)

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

DoCancel()

void

DoCancel

(

)

[private, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel() .

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel() .

CActive::Cancel

DoComplete(TInt &)

void

DoComplete

(

TInt &

)

[private, virtual]

Parameters

TInt &

DoRunL()

void

DoRunL

(

)

[private, virtual]

NewL(CMsvEntry &, RFs &)

IMPORT_C CImPruneMessage *	NewL	(	CMsvEntry &	aEntry,
			RFs &	aFs
		)	[static]

Allocates and constructs a new CImPruneMessage object.

Parameters

CMsvEntry & aEntry	CMsvEntry for use by the object in performing the delete operations. It does not need to be set to any particular message context. The caller retains ownership.
RFs & aFs	Open file server session handle

NewLC(CMsvEntry &, RFs &)

IMPORT_C CImPruneMessage *	NewLC	(	CMsvEntry &	aEntry,
			RFs &	aFs
		)	[static]

Allocates and constructs a new CImPruneMessage object, leaving the object on the cleanup stack.

Parameters

CMsvEntry & aEntry	CMsvEntry for use by the object in performing the delete operations. It does not need to be set to any particular message context. The caller retains ownership.
RFs & aFs	Open file server session handle

PruneEntryL()

void

PruneEntryL

(

)

[private]

ResetStoreL()

void

ResetStoreL

(

)

[private]

StartL(TMsvId, TRequestStatus &)

IMPORT_C void	StartL	(	TMsvId	aMessageEntry,
			TRequestStatus &	aStatus
		)

Starts the asynchronous message clean operation.

Parameters

TMsvId aMessageEntry	The ID of the entry from which to delete the body text and attachment data
TRequestStatus & aStatus	Asynchronous status word that completes with KErrNone when the body text and all of the attachments have been deleted.