EPOC   SDK Home Glossary Indexes Previous Next Up

MBasicGsmPhoneBookSupport class


Contents


MBasicGsmPhoneBookSupport class — Protocol for phone book support

Section Contents


Overview

Derivation

MBasicGsmPhoneBookSupport

Mixin: interface for phone book support functionality.

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

This class defines the protocol to query the supported phone book functionality.


Construction and destruction


MBasicGsmPhoneBookSupport() — Protected default C++ constructor

protected: MBasicGsmPhoneBookSupport()

Description

The default C++ constructor is protected, which prevents objects of this class from being constructed. This class is intended only as an abstract base for other classes.


Query phone book functions


EnumeratePhoneBooks() — Enumerate phone books

virtual TInt EnumeratePhoneBooks(TInt& aPhoneBookCount) const=0;

Description

This function returns the number of phone books supported by the phone.

Arguments

TInt& aPhoneBookCount

On return, contains the number of phone books supported by the phone.

Return value

TInt

An error code: see System error codes.


GetPhoneBookInfo() — Get phone book information — synchronous

virtual TInt GetPhoneBookInfo(const TInt aIndex, TPhoneBookInfo& aInfo) const=0;

Description

This function synchronously retrieves information associated with a selected phone book.

Arguments

const TInt aIndex

The index of the phone book for which information is to be obtained. The valid range for the index is between 0 and (n-1), where n is the number returned by the EnumeratePhoneBooks() function.

TPhoneBookInfo& aInfo

On return, contains information about the specified phone book.

Return value

TInt

An error code: see System error codes.

Note:

GetPhoneBookInfo() — Get phone book information — asynchronous

virtual void GetPhoneBookInfo(TRequestStatus& aStatus, const TInt aIndex, TPhoneBookInfo& aInfo) const=0;

Description

This function asynchronously retrieves information associated with a selected phone book.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TInt aIndex

The index of the phone book for which information is to be obtained. The valid range for the index is between 0 and (n-1), where n is the number returned by the EnumeratePhoneBooks() function.

TPhoneBookInfo& aInfo

On request completion, contains information about the specified phone book.

Note:

GetPhoneBookInfoCancel() — Cancel request to get phone book information

virtual void GetPhoneBookInfoCancel() const=0;

Description

This function cancels an outstanding request to get phone book information, placed using the asynchronous variant of the GetPhoneBookInfo() function.


Struct


TPhoneBookInfo struct — Phone book information

TInt iUsed

The number of used phone book entries. A value of -1 indicates that the parameter is unknown.

Used entries may be scattered across the phone book. There is no requirement for used entries to appear in consecutive slots.

TInt iTotal

The total number of phone book entries. A value of -1 indicates that the TSY can’t get the information from the ME.

TBool iWriteAccess

Indicates whether the client has write access to this phone book.

TBool iRestrictedWriteAccess

Indicates whether the PIN2 password is required to add or delete phone book entries. For example, to change the barred phone number list.

TName iName

The name of the phone book.

TInt iMaxNumberLength

The maximum number of characters available for the number in a phone book entry.

TInt iMaxTextLength

The maximum number of characters available for the text tag in a phone book entry.

EPOC       SDK Home Glossary Indexes Previous Next Up