CMsvCompletedOperation Class Reference

#include <mw/msvapi.h>

class CMsvCompletedOperation : public CMsvOperation, public CMsvOperation

Inherits from

CMsvCompletedOperation
- CMsvOperation
  - CActive
    - CBase
  - CActive
    - CBase
- CMsvOperation
  - CActive
    - CBase
  - CActive
    - CBase

Public Member Functions
	~CMsvCompletedOperation()
virtual const TDesC8 &	FinalProgress()
IMPORT_C CMsvCompletedOperation *	NewL(CMsvSession &, TUid, const TDesC8 &, TMsvId, TRequestStatus &, TInt)
virtual const TDesC8 &	ProgressL()

Inherited Attributes
	CActive::iStatus
	CMsvOperation::iMsvSession
	CMsvOperation::iMtm
	CMsvOperation::iObserverRequestStatus
	CMsvOperation::iService

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	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()
	CMsvOperation::CMsvOperation(CMsvSession &,TInt,TRequestStatus &)
	CMsvOperation::Extension_(TUint,TAny &,TAny )
	CMsvOperation::Id()const
	CMsvOperation::Mtm()const
	CMsvOperation::Service()const
	CMsvOperation::SystemProgress(TMsvSystemProgress &)
	CMsvOperation::~CMsvOperation()

Detailed Description

Utility to create a messaging operation object for an operation that has already completed.

This utility is useful, for example, for writers of MTMs, where the API requires that an asynchronous operation is returned, but where in reality, the operation has performed synchronously. It allows the program to construct an operation object for which the operation is already completed, with the progress information and error code set.

Constructor & Destructor Documentation

~CMsvCompletedOperation ( )

IMPORT_C

~CMsvCompletedOperation

(

)

Destructor.

Any active request on the object is cancelled.

Member Function Documentation

FinalProgress ( )

const TDesC8 &

FinalProgress

(

)

[virtual]

Reimplemented from CMsvOperation::FinalProgress()

Gets information about a completed operation.

Return Value: Descriptor holding progress information.

NewL ( CMsvSession &, TUid, const TDesC8 &, TMsvId, TRequestStatus &, TInt )

IMPORT_C CMsvCompletedOperation *	NewL	(	CMsvSession &	aMsvSession,
			TUid	aMtm,
			const TDesC8 &	aProgress,
			TMsvId	aService,
			TRequestStatus &	aObserverRequestStatus,
			TInt	aErr = KErrNone
		)	[static]

Allocates and constructs a new CMsvCompletedOperation object.

The new object is added to the active scheduler and its asynchronous request immediately set to complete.

Parameters
aMsvSession	Message Server session to use
aMtm	The UID of the MTM associated with the operation.
aProgress	Operation progress information buffer. This is copied by the object.
aService	The ID of the service that is associated with this operation.
aObserverRequestStatus	Request status of the operation observer. This observer is signalled that the operation is complete.
aErr	Error code with which to complete the request. Use KErrNone to indicate that the operation completed successfully.

Return Value: New CMsvOperationActiveSchedulerWait object

Leave Codes
KErrNoMemory

ProgressL ( )

const TDesC8 &

ProgressL

(

)

[virtual]

Reimplemented from CMsvOperation::ProgressL()

Gets information on the progress of the operation.

For a CMsvCompletedOperation, the progress information returned by ProgressL() and FinalProgress() is the same, and is the progress information set in the NewL() function.