CRetrieveMobilePhoneSmspList Class Reference
| class CRetrieveMobilePhoneSmspList : public CAsyncRetrieveWithClientIds |
Reads SMS parameter list from the SIM's SMSP store.
Instead of reading each SMSP entry individually, a client will retrieve all the entries currently stored in one go. A list object (CMobilePhoneSmspList) will be returned to the client. The list object that is returned to the client will contain an entry for each set of SMS parameters.
Due to the probable time taken to retrieve a list, clients must use an asynchronous approach based around the use of this object.
Inherits from
- CRetrieveMobilePhoneSmspList
| Inherited Functions |
|---|
| | CActive::CActive(TInt) |
| | CActive::Cancel() |
| | CActive::Deque() |
| | CActive::Extension_(TUint,TAny *&,TAny *) |
| | CActive::IsActive()const |
| | CActive::IsAdded()const |
| | CActive::Priority()const |
| | CActive::RunError(TInt) |
| | CActive::SetActive() |
| | CActive::SetPriority(TInt) |
| | CActive::~CActive() |
| | CAsyncRetrieveVariableLengthBufferV2::CAsyncRetrieveVariableLengthBufferV2() |
| | CAsyncRetrieveVariableLengthBufferV2::CompleteIfInUse(TRequestStatus &) |
| | CAsyncRetrieveVariableLengthBufferV2::FreeBuffer() |
| | CAsyncRetrieveVariableLengthBufferV2::Start(TRequestStatus &,TDes8 *,TDes8 *) |
| | CAsyncRetrieveVariableLengthBufferV2::~CAsyncRetrieveVariableLengthBufferV2() |
| | CAsyncRetrieveWithClientIds::CAsyncRetrieveWithClientIds(TInt,TInt) |
| | 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() |
Constructor & Destructor Documentation
CRetrieveMobilePhoneSmspList(RMobileSmsMessaging &)
~CRetrieveMobilePhoneSmspList()
| IMPORT_C | ~CRetrieveMobilePhoneSmspList | ( | ) | |
The destructor frees all resources owned by the object, prior to its destruction.
Member Functions Documentation
CancelReq(TInt, TInt)
| void | CancelReq | ( | TInt | aIpc1, |
| | TInt | aIpc2 |
| | ) | [private, virtual] |
This method uses the Cancel IPC request within RTelSubsessionBase to send a cancel for one of the asynchronous phases to ETel server
Parameters
| TInt aIpc1 | The IPC value of the cancel request |
| TInt aIpc2 | The IPC value of the original asynchronous phase request |
ConstructL()
| void | ConstructL | ( | ) | [protected] |
Get(TInt, TRequestStatus &, TDes8 &, TDes8 &)
This method uses the Get IPC request within RTelSubsessionBase to send one of the asynchronous phase requests to ETel server
Parameters
| TInt aIpc | The IPC value of the asynchronous phase request |
| TRequestStatus & aReqStatus | The request status for the asynchronous phase request |
| TDes8 & aDes1 | The first parameter for the asynchronous phase request |
| TDes8 & aDes2 | The second parameter for the asynchronous phase request |
NewL(RMobileSmsMessaging &)
This member function creates an instance of the CActive derived CRetrieveMobilePhoneCbmiList class.
Parameters
| RMobileSmsMessaging & aMessaging | An instance of RMobileSmsMessaging as it is this messaging sub-session that the list retrieval class will operate on. |
RestoreListL()
| void | RestoreListL | ( | ) | [protected, virtual] |
This method restores a list from a buffer that contains the streamed version of the list
RetrieveListL()
This member function provides the client with a handle to the list class retrieved from the store. The client will call this member function once Start() has completed.
When the client calls this member function the ownership of the CMobilePhoneSmspList object will transfer to the client, so the client is then responsible for eventual deletion of this object.
-
leave
- KErrNotFound If there is no valid list object to return to the client.
-
capability
- ReadDeviceData
Start(TRequestStatus &)
This member function starts the two-phase list retrieval.
-
capability
- ReadDeviceData
Parameters
| TRequestStatus & aReqStatus | On completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support access to a SMSP list store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned. |
Member Data Documentation
RMobileSmsMessaging & iMessaging
CMobilePhoneSmspList * iResults
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.