Class CMsvSendErrorActions

class CMsvSendErrorActions : public CBase;

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

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

Members

Defined in CMsvSendErrorActions:
AddSendErrorActionL(), Default(), Errors(), GetSendErrorAction(), NewL(), NewLC(), RemoveSendErrorAction(), Reset(), RestoreFromResourceL(), SetDefault(), SetErrorsL(), ~CMsvSendErrorActions()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CMsvSendErrorActions *NewL();

Description

Allocates and creates a new CMsvSendErrorActions object.

Return value

CMsvSendErrorActions * New object

static IMPORT_C CMsvSendErrorActions *NewLC();

Description

Allocates and creates a new CMsvSendErrorActions object.

Return value

CMsvSendErrorActions * New object

IMPORT_C ~CMsvSendErrorActions();

Description

Destructor.

IMPORT_C void AddSendErrorActionL(const TMsvSendErrorAction &aErrorAction);

Description

Adds a TMsvSendErrorAction object.

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

Parameters

const TMsvSendErrorAction &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 RemoveSendErrorAction() returned an error. KErrAlreadyExists A duplicate was found when inserting the error action in the array.

IMPORT_C TInt RemoveSendErrorAction(const TInt aError);

Description

Removes an error action.

Parameters

const TInt aError Error to remove.

Return value

TInt KErrNotFound if there is no corresponding TMsvSendErrorAction for aError

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

Description

Gets an error action for a specified error.

Parameters

const TInt aError Error to find. TMsvSendErrorAction &aErrorAction On return, the corresponding TMsvSendErrorAction.

Return value

TInt KErrNotFound if there is no corresponding TMsvSendErrorAction for aError.

IMPORT_C void Reset();

Description

IMPORT_C void RestoreFromResourceL(TResourceReader &aReader);

Description

Restores the object from a resource.

The resource must be of type SEND_ERROR_ACTIONS.

Parameters

TResourceReader &aReader Resource reader at appropriate resource.

Leave codes

AddSendErrorActionL()

IMPORT_C void SetErrorsL(const CArrayFixFlat< TMsvSendErrorAction > &aErrors);

Description

Sets the object to an array of error-actions.

Parameters

const CArrayFixFlat< TMsvSendErrorAction > &aErrors Array to use.

Leave codes

AddSendErrorActionL()

IMPORT_C const CArrayFixFlat< TMsvSendErrorAction > &Errors() const;

Description

Gets the object's array of error-actions.

Return value

const CArrayFixFlat< TMsvSendErrorAction > & The object's array of error-actions

IMPORT_C const TMsvSendErrorAction &Default() const;

Description

Gets the default error-action.

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

Return value

const TMsvSendErrorAction & Default error-action

IMPORT_C void SetDefault(const TMsvSendErrorAction &aAction);

Description

Sets the default error-action.

Parameters

const TMsvSendErrorAction &aAction Default error-action.