Class CSmsSimParamOperation

class CSmsSimParamOperation : public CMsvOperation;

Description

Encapsulates an operation to read/write an array of SMS parameters from a SIM.

An operation of this type if returned by the SMS client MTM for the read and write SIM paramter operations.

These operations are generated from calling the SMS client MTM APIs CSmsClientMtm::ReadSimParamsL and CSmsClientMtm::WriteSimParamsL. The CSmsClientMtm::InvokeAsyncFunctionL API should not be used for these operations.

Derivation

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

• CActive - The core class of the active object abstraction

• CMsvOperation - Defines an interface for use by objects which control asynchronous commands in the messaging system

• CSmsSimParamOperation - Encapsulates an operation to read/write an array of SMS parameters from a SIM

Members

Defined in CSmsSimParamOperation:
DoCancel(), ProgressL(), RunError(), RunL(), ServiceCentersLC(), SmspList(), ~CSmsSimParamOperation()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, IsActive(), IsAdded(), Priority(), SetActive(), SetPriority(), TPriority, iStatus

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

Inherited from CMsvOperation:
Extension_(), FinalProgress(), Id(), Mtm(), Service(), SystemProgress(), iMsvSession, iMtm, iObserverRequestStatus, iService

virtual ~CSmsSimParamOperation();

Description

Destructor.

inline const CMobilePhoneSmspList &SmspList() const;

Description

Gets the list of SMS parameters on the SIM, after a successfully completed read operation.

If the operation has not successfully completed, this function returns an empty list.

This function should ot be used with a write SIM parameters operation.

Return value

const CMobilePhoneSmspList & The list of SMS parameters read from the SIM.

Panic codes

SMCM 3 This operation was not reading the SIM parameters. The operation was not returned from CSmsClientMtm::ReadSimParamsL (debug only).

IMPORT_C CMobilePhoneSmspList *ServiceCentersLC() const;

Description

Gets a list of Service Centre addresses.

This function can only be used after a read/write SIM parameters operation has completed. If the CSmsSimParamOperation::ProgressL API returns any an error code other than KErrNone, or the SIM parameters contain no Service Centre addresses, then this function returns an empty list.

Return value

CMobilePhoneSmspList * The list of SMS parameters that only contain Service Centre addresses. A pointer to the list object is left on the cleanup stack.

virtual IMPORT_C const TDesC8 &ProgressL();

Description

Gets the operation completion/error code for reading/writing the SMS parameters.

It returns a packaged TInt (TIntBuf) and not a packaged TSmsProgress.

The code can be intrepreted as follows:

KErrNone - the SMS parameters were successfully read/writte from/to the SIM

KErrNotSupported - the telephone handset and/or TSY module does not support reading/writing the SMS parameters.

KErrNotFound - no SMS parameters where found on the SIM.

Other system-wide error codes - may indicate a comms, telephony or memory error.

Return value

const TDesC8 & A TIntBuf containing the operation completion/error code.

private: virtual void RunL();

Pre-Condition

The async operation is complete

Description

Handles completed async operations.

If the async operation was to read the SIM parameters, then the SIM parameters are read from the appropriate stream in the SMS Service entry and placed in the parameter member iSimParams.

If the async operation was to read the SIM parameters, then there is nothing more to do.

For both types of operation the observer for this operation is completed.

Post-Condition

The operation is complete

Leave codes

KErrNotFound There were no SIM parameters to read from the SIM.

Panic codes

SMCM 3 There was an supported command.

private: virtual void DoCancel();

Description

Cancels any pending async request.

The observer is completed with an value of KErrCancel.

private: virtual TInt RunError(TInt aError);

Description

Handles leaves from RunL().

The observer is completed with the leave code aError.

Parameters

TInt aError The leave code from RunL().

Return value

TInt A value of KErrNone.