![[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
RPhone
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(), GetLineInfo(), GetStatus(), 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.
Note:
Opened phone subsessions must be explicitly closed by
the client — a memory leak will result if the 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.
Notes:
The phone hardware is usually automatically initialised before the first command is sent.
Functions which retrieve information about the modem should be used once this function has completed — such information may be incorrect before initialisation is 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.
Notes:
The phone hardware is usually automatically initialised before the first command is sent.
Functions which retrieve information about the modem should be used once this function has completed — such information may be incorrect before initialisation is 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.
Note:
This function is expected to complete quickly. Consequently, an asynchronous variant has not been provided.
|
|
TInt GetInfo(TPhoneInfo& aPhoneInfo) const;
Supported from 5.1
Gets a snapshot of the current phone information.
Note:
This function is expected to complete quickly. Consequently, an asynchronous variant has not been provided.
|
|
|
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.
Note:
Clearly, this function has no use if the modem (DCE) is permanently attached to the computing device (DTE).
|
void NotifyModemDetectedCancel() const;
Cancels an outstanding modem detection notification, placed using
theNotifyModemDetected() function.
void NotifyOnAnything(TRequestStatus& aStatus,TPhoneNotifyInfo& aPhoneNotifyInfo);
Supported from 5.0
Withdrawn in 5.1
Provides notification if the phone information changes.
Note:
This function is effectively the same
asNotifyModemDetected() because the only changes detected are to
the modem detection status.
|
void NotifyOnAnythingCancel() const;
Supported from 5.0
Withdrawn in 5.1
Cancels an "Any change" notification request, placed using
theNotifyOnAnything() 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
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
iFlagsTUint iFlags
Phone capability flag. Contains bitmask of values defined in
theTCapsFlags enumeration.
TStatus
Current phone status.
Defined in RPhone::TStatus:
iMode, iModemDetected
iModemDetectedTModemDetection iModemDetected
The current modem connection status. For values
seeTModemDetection enumeration.
iModeTMode iMode
The current mode of the phone. For values,
seeTModeenumeration
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.
RPhone::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
|
|
TBool iDetectionChanged
An indication that the modem detection state has changed since the last notification.
RPhone::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
|
|
TModemDetection iDetection
The current modem detection state (is it present or not).
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up.gif){kind=icon}