![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
RTelSubSessionBase |
Base class. Defines telephony sub-session. |
etelbgsm.h
gsmbas.lib
This class encapsulates the functionality associated with SMS stores. Using this class, clients can open and close SMS stores, read, write and delete SMS messages from a store, determine which of a stores message slots are filled, and receive notification when a message store is written to by another client.
This is the preferred class for working with stores, even though there is some overlap with the functionality provided by the RSmsMessaging class.
This class is not intended for user derivation
RSmsStorage();
The default C++ constructor constructs a messaging object, and initialises the member variables.
TInt Open(RSmsMessaging& aMessaging,const TDesC& aStore);
This function opens a specified message store.
RSmsMessaging& aMessaging |
The messaging sub-session from which the store is to be opened. |
const TDesC& aStore |
The name of the message store to be opened. This can take one of the phone store type names see SMS Phone store types. |
TInt |
An error code: see System error codes. |
void Close();
This function closes an open message store.
TInt GetInfo(TInfo& aInfo) const;
This synchronous function retrieves the total number of message storage slots, and the number of used slots in the message store. It does not give information about which slots are filled and which are empty.
TInfo& aInfo |
On return, contains the message store slot information. |
TInt |
An error code: see System error codes. |
void GetInfo(TRequestStatus& aStatus, TInfo& aInfo);
This asynchronous function retrieves the total number of message storage slots, and the number of used slots in the message store. It does not give information about which slots are filled and which are empty.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TInfo& aInfo |
On request completion, contains the message store slot information. |
void GetInfoCancel() const;
This function cancels an outstanding request for the message store slot information, placed using the asynchronous variant of the GetInfo() function.
TInt ReadSms(const TInt aIndex, TSmsMsgStoreEntry& aMsgEntry) const;
This synchronous function reads the message in a specified slot of the message store.
const TInt aIndex |
The index of the slot from which the message is read. |
TSmsMsgStoreEntry& aMsgEntry |
On return, contains the read message. |
TInt |
An error code: see System error codes. |
void ReadSms(TRequestStatus& aStatus, const TInt aIndex, TSmsMsgStoreEntry& aMsgEntry);
This asynchronous function reads the message in a specified slot of the message store.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TInt aIndex |
The index of the slot from which the message is read. |
TSmsMsgStoreEntry& aMsgEntry |
On request completion, contains the read message. |
void ReadSmsCancel() const;
This function cancels an outstanding request to read a specified message in the message store, placed using the asynchronous variant of the ReadSms() function.
void WriteNotification(TRequestStatus& aStatus, TInt& aIndex);
This function provides notification when a message is written to, or deleted from, the specified message store. The request completes when a new message is written to the store.
This is useful in the case where several clients are reading, writing and deleting messages from the same store.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TInt& aIndex |
On request completion, contains the index of the new message. |
void WriteNotificationCancel() const;
This function cancels an outstanding request for notification of changes to the message store, placed using the WriteMessageNotification() function.
TInt Write(TInt& aIndex, const TSmsMsgStoreEntry& aMsg) const;
This synchronous function writes a message to a message store.
TInt& aIndex |
On return, contains the index of the message slot in which the message was written. |
const TSmsMsgStoreEntry& aMsg |
The message to be written to the store. |
TInt |
An error code: see System error codes. |
void Write(TRequestStatus& aStatus, TInt& aIndex, const TSmsMsgStoreEntry& aMsg);
This asynchronous function writes a message to a message store.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TInt& aIndex |
On request completion, contains the index of the message slot in which the message was written. |
const TSmsMsgStoreEntry& aMsg |
The message to be written to the store. |
void WriteCancel() const;
This function cancels an outstanding write message request, placed using the asynchronous variant of the WriteMessage() function.
TInt Delete(const TInt aIndex) const;
This synchronous function deletes a message from a specified message slot.
const TInt aIndex |
The message store slot index which contains the message to be deleted. |
TInt |
An error code: see System error codes. |
void Delete(TRequestStatus& aStatus, const TInt aIndex);
This asynchronous function deletes a message from a specified message slot.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TInt aIndex |
The index, of the slot in the message store, of the message to be deleted. |
void DeleteCancel() const;
This function cancels an outstanding request to delete a message, placed using the asynchronous variant of the DeleteMessage() function.
The message is unread. |
|
The message has been read previously. |
|
The message has not been sent. |
|
The message has been sent. |
TUint iUsed |
The number of messages stored in a store. |
TUint iTotal |
The total number of messages that may be stored. |
TSms iMsg |
The actual stored message. |
TStatus iStatus |
The status of the stored message. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |