CMsvSendErrorActions Class Reference

#include <mw/msvsenderroraction.h>

Link against: schsend.lib

class CMsvSendErrorActions : public CBase

Inherits from

CMsvSendErrorActions
- CBase

Public Member Functions
	~CMsvSendErrorActions()
IMPORT_C void	AddSendErrorActionL(const TMsvSendErrorAction &)
IMPORT_C const TMsvSendErrorAction &	Default()
IMPORT_C const CArrayFixFlat< TMsvSendErrorAction > &	Errors()
IMPORT_C TInt	GetSendErrorAction(const TInt, TMsvSendErrorAction &)
IMPORT_C CMsvSendErrorActions *	NewL()
IMPORT_C CMsvSendErrorActions *	NewLC()
IMPORT_C TInt	RemoveSendErrorAction(const TInt)
IMPORT_C void	Reset()
IMPORT_C void	RestoreFromResourceL(TResourceReader &)
IMPORT_C void	SetDefault(const TMsvSendErrorAction &)
IMPORT_C void	SetErrorsL(const CArrayFixFlat< TMsvSendErrorAction > &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Detailed Description

This class determines what action to take if an error occurs while the Server MTM is sending a message (or messages).

It encapsulates an array of TMsvSendErrorAction objects, which it uses to determine the action to take for a particular error. If the error is not found in the array, then CMsvSendErrorActions uses its default TMsvSendErrorAction object.

Constructor & Destructor Documentation

~CMsvSendErrorActions ( )

IMPORT_C

~CMsvSendErrorActions

(

)

Destructor.

Member Function Documentation

AddSendErrorActionL ( const TMsvSendErrorAction & )

IMPORT_C void

AddSendErrorActionL

(

const TMsvSendErrorAction &

aErrorAction

)

Adds a TMsvSendErrorAction object.

If a TMsvSendErrorAction already exists in the collection for the same error, then it is replaced by aAction.

Parameters
aErrorAction	Error action to add.

Leave Codes
Any	error code but KErrNone and KErrNotFound We tried to delete the error action if it already exists and
KErrAlreadyExists	A duplicate was found when inserting the error action in the array.

Default ( )

IMPORT_C const TMsvSendErrorAction &

Default

(

)

const

Gets the default error-action.

The default is used if a specified error-action is not found for the error.

Return Value: Default error-action

Errors ( )

IMPORT_C const CArrayFixFlat< TMsvSendErrorAction > &

Errors

(

)

const

Gets the object's array of error-actions.

Return Value: The object's array of error-actions

GetSendErrorAction ( const TInt, TMsvSendErrorAction & )

IMPORT_C TInt	GetSendErrorAction	(	const TInt	aError,
			TMsvSendErrorAction &	aErrorAction
		)	const

Gets an error action for a specified error.

Parameters
aError	Error to find.
aErrorAction	On return, the corresponding TMsvSendErrorAction.

Return Value: KErrNotFound if there is no corresponding TMsvSendErrorAction for aError.

NewL ( )

IMPORT_C CMsvSendErrorActions *

NewL

(

)

[static]

Allocates and creates a new CMsvSendErrorActions object.

Return Value: New object

NewLC ( )

IMPORT_C CMsvSendErrorActions *

NewLC

(

)

[static]

Allocates and creates a new CMsvSendErrorActions object.

Return Value: New object

RemoveSendErrorAction ( const TInt )

IMPORT_C TInt

RemoveSendErrorAction

(

const TInt

aError

)

Removes an error action.

Parameters
aError	Error to remove.

Return Value: KErrNotFound if there is no corresponding TMsvSendErrorAction for aError

Reset ( )

IMPORT_C void

Reset

(

)

RestoreFromResourceL ( TResourceReader & )

IMPORT_C void

RestoreFromResourceL

(

TResourceReader &

aReader

)

Restores the object from a resource.

The resource must be of type SEND_ERROR_ACTIONS.

Parameters
aReader	Resource reader at appropriate resource.

Leave Codes

SetDefault ( const TMsvSendErrorAction & )

IMPORT_C void

SetDefault

(

const TMsvSendErrorAction &

aAction

)

Sets the default error-action.

Parameters
aAction	Default error-action.

SetErrorsL ( const CArrayFixFlat< TMsvSendErrorAction > & )

IMPORT_C void

SetErrorsL

(

const CArrayFixFlat< TMsvSendErrorAction > &

aErrors

)

Sets the object to an array of error-actions.

Parameters
aErrors	Array to use.

Leave Codes