![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
RTelSubSessionBase |
Base class. Defines telephony sub-session. |
etelbgsm.h
gsmbas.lib
Provides access to the functionality associated with a phone book.
This class is not intended for user derivation
RGsmPhoneBook();
The default C++ constructor constructs a phone book object.
RGsmPhoneBook(const RGsmPhoneBook& aPhoneBook);
The C++ copy constructor constructs a new RGsmPhoneBook object from an existing one.
const RGsmPhoneBook& aPhoneBook |
The phone book being copied. |
TInt GetCaps(TCaps& aCaps) const;
This function retrieves the phone books static capabilities.
TCaps& aCaps |
On return, contains the phone books static capabilities. |
TInt |
An error code: see System error codes. |
TInt Open(RPhone& aPhone, const TDesC& aType);
This function opens a specified phone book.
RPhone& aPhone |
The phone subsession in which the phone book is being opened. |
const TDesC& aType |
The name of the phone book to be opened. Known phone books are described in the Existing phone book constants section below. |
TInt |
An error code: see System error codes. |
void Close();
This function closes a phone book.
TInt GetInfo(RBasicGsmPhone::TPhoneBookInfo& aInfo) const;
This synchronous function retrieves a phone books information.
RBasicGsmPhone::TPhoneBookInfo& aInfo |
On return, contains information about the phone book. |
TInt |
An error code: see System error codes. |
void GetInfo(TRequestStatus& aStatus, RBasicGsmPhone::TPhoneBookInfo& aInfo);
This asynchronous function retrieves a phone books information.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
RBasicGsmPhone::TPhoneBookInfo& aInfo |
On request completion, contains information about the phone book. |
void GetInfoCancel() const;
This function cancels an outstanding request to retrieve phone book information, placed with the asynchronous variant of the GetInfo() function.
TInt Read(TEntry& aEntry);
This synchronous function retrieves the phone book entry associated with the index specified in the TEntry structure.
TEntry& aEntry |
Phone book entry structure with the desired index specified in the iIndex member variable. On return, contains all the specified phone book entry information. |
TInt |
An error code: see System error codes. |
void Read(TRequestStatus& aStatus, TEntry& aEntry);
This asynchronous function retrieves the phone book entry associated with the index specified in the TEntry structure.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TEntry& aEntry |
Phone book entry structure with the desired index specified in the iIndex member variable. On return, contains all the specified phone book entry information. |
void ReadCancel() const;
This function cancels an outstanding phone book entry read request, placed using the asynchronous variant of the Read() function.
TInt ReadFirst(TEntry& aEntry);
This synchronous function reads the entry in the first phone book slot.
TEntry& aEntry |
On return, contains the entry in the first phone book slot. |
TInt |
An error code: see System error codes. |
void ReadFirst(TRequestStatus& aStatus, TEntry& aEntry);
This asynchronous function reads the entry in the first phone book slot.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TEntry& aEntry |
On request completion, contains the entry in the first phone book slot. |
void ReadFirstCancel() const;
This function cancels a request to read the first phone book entry, placed using the asynchronous variant of the ReadFirst() function.
TInt ReadPrevious(TEntry& aEntry);
This synchronous function retrieves the previous phone book entry. It should be preceded by at least one Read() function, to ensure the phone book cursor is greater than 1.
TEntry& aEntry |
On return, contains the previous entry index one less than the last entry read. |
TInt |
An error code: see System error codes. |
void ReadPrevious(TRequestStatus& aStatus, TEntry& aEntry);
This asynchronous function retrieves the previous phone book entry. It should be preceded by at least one Read() function, to ensure the phone book cursor is greater than 1.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TEntry& aEntry |
On request completion, contains the previous entry index one less than the last entry read. |
void ReadPreviousCancel() const;
This function cancels a request to read the previous phone book entry, placed using the asynchronous variant of the ReadPrevious() function.
TInt ReadNext(TEntry& aEntry);
This synchronous function retrieves the next phone book entry. It should be preceded by a Read() or ReadFirst() function, to ensure the phone book cursor is correctly positioned.
TEntry& aEntry |
On return, contains the next entry (index one more than the last entry read). |
TInt |
An error code: see System error codes. |
void ReadNext(TRequestStatus& aStatus, TEntry& aEntry);
This asynchronous function retrieves the next phone book entry. It should be preceded by a Read() or ReadFirst() function, to ensure the phone book cursor is correctly positioned.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TEntry& aEntry |
On request completion, contains the next entry (index one more than the last entry read). |
void ReadNextCancel() const
This function cancels a request to read the next phone book entry, placed using the asynchronous variant of the ReadNext() function.
TInt Write(TEntry& aEntry) const;
This synchronous function writes an entry to the phone book.
TEntry& aEntry |
The entry to be written. The entry is written to the phone book slot specified by the aEntry.iIndex variable. |
TInt |
An error code: see System error codes. |
void Write(TRequestStatus& aStatus, TEntry& aEntry);
This asynchronous function writes an entry to the phone book.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TEntry& aEntry |
The entry to be written. The entry is written to the phone book slot specified by the aEntry.iIndex variable. |
void WriteCancel() const;
This function cancels an outstanding request to write a phone book entry, placed using the asynchronous variant of the Write() function.
TInt Delete(TInt aIndex) const;
This synchronous function is used to delete phone book entries.
TInt aIndex |
The index of the phone book entry that is to be deleted. |
TInt |
An error code: see System error codes. |
void Delete(TRequestStatus& aStatus, TInt aIndex);
This asynchronous function is used to delete phone book entries.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TInt aIndex |
The index of the phone book entry that is to be deleted. |
void DeleteCancel() const;
This function cancels an outstanding request to delete a phone book entry, placed using the asynchronous variant of the Delete() function.
void EntryChangedNotification(TRequestStatus& aStatus,TInt& aIndex);
This function provides notification when an entry in the phone book is modified.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TInt& aIndex |
On request completion, contains the index number of the modified entry. |
void EntryChangedNotificationCancel() const;
This function cancels an asynchronous phone book entry change notification request, placed using the EntryChangedNotification() function.
The asynchronous phone book search functions are defined in the CGsmPhoneBookSearch and CGsmPhoneBookResults classes. It is recommended that developers use these, rather than the synchronous function (defined below), as the search may take some time.
CGsmPhoneBookResults* SearchLC(const TSearchString& aSearch);
This synchronous function finds the search string in a phone book.
const TSearchString& aSearch |
The search string to be located. This is matched against the first letters in each entry. |
CGsmPhoneBookResults* |
On return, contains the results of the search. |
New entries can be written to, or deleted from, the phone book. |
|
New entries can only be written to, or deleted from, the phone book using the PIN2 password. |
|
The phone book supports notification functions. For example, it can inform clients when addresses have been added or removed. |
Max size of a phone book entry (100). |
TUint iCaps |
Bitmask of the phone book capability flags defined in the enumeration section. |
typedef TBuf8<KPhoneBookEntrySize> TSearchString;
etelbgsm.h
Objects of this type are used to pass search strings into phone book entry search functions.
A phone book containing the fixed SIM dialling list. |
|
An ME-based phone book. |
|
A combination of ME and SIM-based phone books. |
|
A SIM-based phone book. |
|
A TA-based phone book |
|
A phone book containing the most recently dialled calls, stored in either ME or SIM. |
|
A phone book containing the emergency number. |
|
A phone book containing barred numbers. |
|
A phone book containing missed calls. |
|
A phone book containing received calls. |
Section Contents
Scoped class. Defines structure of a phone book entry. |
etelbgsm.h
gsmbas.lib
Provides data structure for containing the information belonging to a phone book entry.
This class is not intended for user derivation
The class does not declare a constructor.
TGsmTelNumber iTelNumber |
A GSM Telephone number. |
TBuf8<KPhoneBookEntrySize> iText |
The name associated with the phone book entry. When writing to a phone book entry, the characters in this text string are mapped to characters in the 7-bit GSM character set. |
TInt iIndex |
The index number associated with the phone book entry. |
TName iPhoneBookName |
The name of the phone book. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |