CMsvSendErrorActions Class Reference

#include <mw/msvsenderroraction.h>

Link against: schsend.lib

class CMsvSendErrorActions : public CBase

Inherits from

  • CMsvSendErrorActions

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 voidAddSendErrorActionL(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
aErrorActionError action to add.
Leave Codes
Anyerror code but KErrNone and KErrNotFound We tried to delete the error action if it already exists and
KErrAlreadyExistsA 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 TIntGetSendErrorAction(const TIntaError,
TMsvSendErrorAction &aErrorAction
)const

Gets an error action for a specified error.

Parameters
aErrorError to find.
aErrorActionOn 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 TIntRemoveSendErrorAction(const TIntaError)

Removes an error action.

Parameters
aErrorError to remove.
Return Value
KErrNotFound if there is no corresponding TMsvSendErrorAction for aError

Reset ( )

IMPORT_C voidReset()

RestoreFromResourceL ( TResourceReader & )

IMPORT_C voidRestoreFromResourceL(TResourceReader &aReader)

Restores the object from a resource.

The resource must be of type SEND_ERROR_ACTIONS.

Parameters
aReaderResource reader at appropriate resource.
Leave Codes

SetDefault ( const TMsvSendErrorAction & )

IMPORT_C voidSetDefault(const TMsvSendErrorAction &aAction)

Sets the default error-action.

Parameters
aActionDefault error-action.

SetErrorsL ( const CArrayFixFlat< TMsvSendErrorAction > & )

IMPORT_C voidSetErrorsL(const CArrayFixFlat< TMsvSendErrorAction > &aErrors)

Sets the object to an array of error-actions.

Parameters
aErrorsArray to use.
Leave Codes