![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
RTelSubSessionBase |
Abstract: implements a subsession |
etel.h
etel.lib
The phone sub-session provides access to the functionality associated with a specific phone.
This class is not intended for user derivation.
RPhone();
The constructor is empty, and is present only to support virtual function table export: see Implications of static DLLs.
TInt Open(RTelServer& aSession,const TDesC& aName);
This function opens a phone subsession by name, and starts the modem initialisation process.
RTelServer& aSession |
A session, that must be connected to the server. |
Const TDesC& aName |
The name of the phone to be opened |
TInt |
An error code: see System error codes. |
void Close();
This function closes the phone. This function must be called for all RPhone subsessions which have been opened to prevent memory leakage.
Initialisation places the modem into a state in which it can receive commands, and in which the TSY can query its capabilities.
TInt Initialise();
This asynchronous function initialises, or re-initialises, a phone. If the function is called during the automatic initialisation, the function completes when the phone is initialised. If the function is called after the automatic initialisation has finished, the phone is re-initialised.
Initialisation may take significant time to complete.
TInt |
An error code: see Error codes. Errors which might be returned are: KErrEtelInitialisationFailure and KErrEtelModemNotDetected. |
void Initialise(TRequestStatus& aStatus);
This asynchronous function initialises, or re-initialises, a phone. If the function is called during the automatic initialisation, the function completes when the phone is initialised. If the function is called after the automatic initialisation has finished, the phone is re-initialised.
Initialisation may take significant time to complete.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. Errors which might be returned are: KErrEtelInitialisationFailure and KErrEtelModemNotDetected. |
void InitialiseCancel();
This function cancels a request to initialise the modem, placed using the asynchronous variant of the Initialise() function.
TInt GetCaps(TCaps& aCaps) const;
This function retrieves the phones capabilities.
TCaps& aCaps |
On return, contains the phone capabilities. |
TInt |
An error code: see System error codes. |
TInt GetStatus(TStatus& aStatus) const;
This function retrieves information about the status of the phone.
TStatus& aStatus |
On return, contains the current phone status. |
TInt |
An error code: see System error codes. |
TInt EnumerateLines(TInt& aCount) const;
This function returns the number of lines associated with the phone.
TInt& aCount |
On return, contains the number of lines associated with the phone. |
TInt |
An error code: see System error codes. |
TInt GetLineInfo(const TInt aIndex,TLineInfo& aLineInfo) const;
This function returns enough information about a line to differentiate it from other lines associated with the phone.
const TInt aIndex |
The index of the line for which information is required. |
TLineInfo& aLineInfo |
On return, contains the line information. |
TInt |
An error code: see System error codes. |
TInt GetInfo(TPhoneNotifyInfo& aPhoneNotifyInfo) const;
This function retrieves a snapshot of the current phone information.
TPhoneNotifyInfo& aPhoneNotifyInfo |
On return, contains the current phone information |
TInt |
An error code: see System error codes. |
void NotifyModemDetected(TRequestStatus& aStatus,TModemDetection& aDetection);
This function provides notification when the local modem is detected, or when a previously connected modem can no longer be contacted.
TRequestStatus& aStatus |
A flag that indicates the completion status of the request. |
TModemDetection& aDetection |
On return, contains the new status. |
void NotifyModemDetectedCancel() const;
This function cancels an outstanding modem detection notification, placed using the NotifyModemDetected() function.
void NotifyOnAnything(TRequestStatus& aStatus,TPhoneNotifyInfo& aPhoneNotifyInfo);
This function provides notification if the phone information changes.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TPhoneNotifyInfo& aPhoneNotifyInfo |
On request completion, contains the new phone information. |
void NotifyOnAnythingCancel() const;
This function cancels an "Any change" notification request, placed using the NotifyOnAnything() function.
void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);
This function provides notification of changes in phone capabilities.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TCaps& aCaps |
On request completion, contains the phone capabilities. |
void NotifyCapsChangeCancel() const;
This function cancels a "Capabilities change" notification request, placed using the NotifyCapsChange() function.
The capabilities of the phone are not known. |
|
The phone supports data calls. |
|
The phone supports the fax class 1 interface. |
|
The phone supports the fax class 1.0 interface. |
|
The phone supports the fax class 2 interface. |
|
The phone supports the fax class 2.0 interface. |
|
The phone supports the fax class 2.1 interface. |
|
The phone supports voice calls. |
|
The phone supports modem detection events, i.e. it can notify clients when the modem can be or can no longer be detected. |
|
The phone supports the ability to take the communications port from whatever component is currently using it. |
Phone (modem) status unknown. |
|
Phone is idle. |
|
Phone is establishing link. |
|
Modem is in data mode. |
|
Modem is in command mode and the line is active. |
Modem present. |
|
Modem is not present. |
|
Modem connection status is unknown. |
TUint iFlags |
Phone capability flag. Contains bitmask of values defined in the TCapsFlags enumeration. |
TModemDetection iModemDetected |
The current modem connection status. For values see TModemDetection enumeration. |
TMode iMode |
The current mode of the phone. For values, see TMode enumeration |
RCall::TStatus iStatus |
The current line status. |
TUint32 iLineCapsFlags |
The line capabilities flag. |
TName iName |
The name of the line. |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
RPhone::TPhoneNotifyInfo |
Provides structure to contain phone notification information. |
etel.h
etel.lib
All the information associated with an instance of the core API phone class is collected together into a single, directly accessible, structure. This increases the efficiency of applications that require access to the majority of the phones data.
This class is not intended for user derivation.
RPhone::TPhoneNotifyInfo();
The constructor is empty.
TModemDetection iDetection |
The current modem detection state (is it present or not). |
TBool iDetectionChanged |
An indication that the modem detection state has changed since the last notification. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |