![[Index]](../../../../_stock/btn_index.gif){kind=small}
![[Glossary]](../../../../_stock/btn_glossary.gif){kind=small}
![[Previous]](../../../../_stock/btn_prev.gif){kind=small}
![[Next]](../../../../_stock/btn_next.gif){kind=small}
|
|
|
|
|
Location:
etel.h
Link against: etel.lib
class RPhone : public RTelSubSessionBase;
Supported from 5.0
Phone sub-session.
Provides access to the functionality associated with a specific phone.
This class is not intended for user derivation.
|
Defined in RPhone:
Close(), EDetectedNotPresent, EDetectedPresent, EDetectedUnknown, EModeEstablishingLink, EModeIdle, EModeOnlineCommand, EModeOnlineData, EModeUnknown, EnumerateLines(), GetCaps(), GetInfo(), GetInfo(), GetLineInfo(), GetStatus(), Initialise(), Initialise(), InitialiseCancel(), KCapsData, KCapsEventModemDetection, KCapsFaxClassOne, KCapsFaxClassOnePointZero, KCapsFaxClassTwo, KCapsFaxClassTwoPointOne, KCapsFaxClassTwoPointZero, KCapsStealCommPort, KCapsUnknown, KCapsVoice, NotifyCapsChange(), NotifyCapsChangeCancel(), NotifyModemDetected(), NotifyModemDetectedCancel(), NotifyOnAnything(), NotifyOnAnythingCancel(), Open(), RPhone(), TCaps, TCapsFlags, TLineInfo, TMode, TModemDetection, TPhoneInfo, TPhoneNotifyInfo, TStatus
RPhone();
Empty default constructor.
Constructs an empty RPhone object, and is present
only to support virtual function table export.
|
TInt Open(RTelServer& aSession,const TDesC& aName);
Opens a phone subsession by name, and starts the modem initialisation process.
|
|
![[Top]](../../../../_stock/arrow_up_2.gif){kind=icon}
RPhone object is
destroyed before the subsession is closed.void Close();
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();
Initialises, or re-initialises, a phone — synchronous. 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.
|
void Initialise(TRequestStatus& aStatus);
Initialises or re-initialises a phone — asynchronous.
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.
|
void InitialiseCancel();
Cancels a request to initialise the modem, placed using the
asynchronous variant of the Initialise() function.
|
TInt GetCaps(TCaps& aCaps) const;
Gets the phone's capabilities.
|
|
TInt GetStatus(TStatus& aStatus) const;
Gets information about the status of the phone.
|
|
TInt EnumerateLines(TInt& aCount) const;
Gets the number of lines associated with the phone.
|
|
TInt GetLineInfo(const TInt aIndex,TLineInfo& aLineInfo) const;
Gets enough information about a line to differentiate it from other lines associated with the phone.
|
|
TInt GetInfo(TPhoneNotifyInfo& aPhoneNotifyInfo) const;
Supported from 5.0
Withdrawn in 5.1
Gets a snapshot of the current phone information.
|
|
TInt GetInfo(TPhoneInfo& aPhoneInfo) const;
Supported from 5.1
Gets a snapshot of the current phone information.
|
|
|
void NotifyModemDetected(TRequestStatus& aStatus,TModemDetection& aDetection);
Provides notification when the local modem is detected, or when a previously connected modem can no longer be contacted.
|
void NotifyModemDetectedCancel() const;
Cancels an outstanding modem detection notification, placed
using the NotifyModemDetected() function.
void NotifyOnAnything(TRequestStatus& aStatus,TPhoneNotifyInfo& aPhoneNotifyInfo);
Supported from 5.0
Withdrawn in 5.1
Provides notification if the phone information changes.
|
void NotifyOnAnythingCancel() const;
Supported from 5.0
Withdrawn in 5.1
Cancels an "Any change" notification request, placed using the
NotifyOnAnything() function.
void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);
Provides notification of changes in phone capabilities.
|
void NotifyCapsChangeCancel() const;
Cancels a "Capabilities change" notification request, placed
using the NotifyCapsChange() function.
|
TCapsFlags
Phone capability flags.
|
TMode
Phone mode status flags.
|
TModemDetection
Modem connection status flags.
|
|
TCaps
Phone capability information.
Defined in RPhone::TCaps:
iFlags
iFlagsTUint iFlags
Phone capability flag. Contains bitmask of values defined in
the TCapsFlags enumeration.
TStatus
Current phone status.
Defined in RPhone::TStatus:
iMode, iModemDetected
iModemDetectedTModemDetection iModemDetected
The current modem connection status.
iModeTMode iMode
The current mode of the phone. For values.
TLineInfo
Line information.
Defined in RPhone::TLineInfo:
iLineCapsFlags, iName, iStatus
iStatusRCall::TStatus iStatus
The current line status.
iLineCapsFlagsTUint32 iLineCapsFlags
The line capabilities flag.
iNameTName iName
The name of the line.
|
class TPhoneNotifyInfo;
Supported from 5.0
Withdrawn in 5.1
Phone notification information
Collects 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 phone's data.
This class is not intended for user derivation.
Defined in RPhone::TPhoneNotifyInfo:
TPhoneNotifyInfo(), iDetection, iDetectionChanged
TPhoneNotifyInfo()RPhone::TPhoneNotifyInfo();
Empty constructor.
iDetectionTModemDetection iDetection
The current modem detection state (is it present or not).
iDetectionChangedTBool iDetectionChanged
An indication that the modem detection state has changed since the last notification.
class TPhoneInfo;
Supported from 5.1
Phone notification information.
Collects 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 phone's data.
This class is not intended for user derivation.
Defined in RPhone::TPhoneInfo:
TPhoneInfo(), iDetection
TPhoneInfo()RPhone::TPhoneInfo();
Empty constructor.
iDetectionTModemDetection iDetection
The current modem detection state (is it present or not).
©2002 Symbian Ltd. |
|
![[Top]](../../../../_stock/arrow_up.gif){kind=icon}