![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
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 line sub-session provides access to the functionality associated with a specific line.
This class is not intended for user derivation
RLine();
The constructor is empty, and is present only to support virtual function table export: see Implications of static DLLs.
TInt Open(RPhone& aPhone,const TDesC& aName);
This function opens a line from a phone connection.
RPhone& aPhone |
The phone from which the line is to be opened. |
const TDesC& aName |
The name of the line. Must match the name returned by the RPhone::GetLineInfo() function. |
TInt |
An error code: see System error codes. |
TInt Open(RTelServer& aServer,const TDesC& aName);
This function opens a line from a server connection. It might be used, in preference to the previous version, when access to phone functionality is not required.
RTelServer& aServer |
The server from which the line is to be opened. |
const TDesC& aName |
The name of the line. The format of the name must be as shown below: |
TInt |
An error code: see System error codes. |
void Close();
This function closes the line. This function must be called for all RLine subsessions which have been opened to prevent memory leakage.
TInt GetCaps(TCaps& aCaps) const;
This function retrieves the line capabilities.
TCaps& aCaps |
On return, contains the line capabilities. |
TInt |
An error code: see System error codes. |
TInt GetStatus(RCall::TStatus& aStatus) const;
This function returns line status information.
RCall::TStatus& aStatus |
On return, contains the line status. |
TInt |
An error code: see System error codes. |
TInt GetHookStatus(RCall::THookStatus& aHookStatus) const;
This function retrieves the current hook status.
RCall::THookStatus& aHookStatus |
On return, contains the current hook status |
TInt |
An error code: see System error codes. |
TInt EnumerateCall(TInt& aCount) const;
This function returns the number of calls opened from a line.
TInt& aCount |
On return, contains the number of calls opened from the line. |
TInt |
An error code: see System error codes. |
TInt GetCallInfo(TInt aIndex,TCallInfo& aCallInfo) const;
This function returns enough information about a call to differentiate it from other calls on the line.
TInt aIndex |
The index of the call for which information is to be obtained. |
TCallInfo& aCallInfo |
On return, contains the call information. |
TInt |
An error code: see System error codes. |
TInt GetInfo(TLineNotifyInfo& aLineNotifyInfo) const;
This function retrieves a snapshot of the current line information.
TLineNotifyInfo& aLineNotifyInfo |
On return, contains the current line information |
TInt |
An error code: see System error codes. |
void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);
This function provides notification of a change in the line capabilities.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TCaps& aCaps |
On request completion, contains the new line capabilities |
void NotifyCapsChangeCancel() const;
This function cancels an "line capabilities change" notification request, placed using the NotifyCapsChange() function.
void NotifyOnAnything(TRequestStatus& aStatus,TLineNotifyInfo& aLineNotifyInfo);
This function provides notification of any change in the line information.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TLineNotifyInfo& aLineNotifyInfo |
On request completion, contains the new line information. |
void NotifyOnAnythingCancel() const;
This function cancels an "any change" notification request, placed using the NotifyOnAnything() function.
void NotifyIncomingCall(TRequestStatus& aStatus, TName& aName);
This function is used to notify a client when an incoming call is detected.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TName& aName |
On request completion, contains the name of the incoming call. |
void NotifyIncomingCallCancel() const;
This function cancels an outstanding incoming call notification, placed with the NotifyIncomingCall() function.
void NotifyHookChange(TRequestStatus& aStatus,RCall::THookStatus& aHookStatus);
This function provides notification when the hook status changes.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
RCall::THookStatus& aHookStatus |
On request completion, contains the new hook status. |
void NotifyHookChangeCancel() const;
This function cancels an outstanding hook change notification request, placed using the NotifyHookChange() function.
TInt RegisterNotifyStatusChange(const TInt aBufferSize) const;
This function causes the server to create a buffer, specifically for the requesting client, to store line status change information. This buffer ensures that information is not lost between the completion of the clients line status change request, and its next request being posted.
This function only creates a buffer for the notification. To actually get the status information use the NotifyStatusChange() function.
const TInt aBufferSize |
The number of events that the server can buffer |
TInt |
An error code: see System error codes. |
TInt DeregisterNotifyStatusChange() const;
This function deletes the buffer in the server. If a client has a status change notification request still outstanding, it will remain so.
TInt |
An error code: see System error codes. |
void NotifyStatusChange(TRequestStatus& aStatus,RCall::TStatus& aLineStatus);
This function provides notification about a change in the line status.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
RCall::TStatus& aLineStatus |
On request completion, contains the new line status. |
void NotifyStatusChangeCancel() const;
This function cancels an outstanding line status change notification request, placed using the NotifyStatusChange() function.
void NotifyCallAdded(TRequestStatus& aStatus,TName& aName);
This function provides notification that a new call is being added to the line.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TName& aName |
On request completion, contains the name of the new call. |
void NotifyCallAddedCancel() const;
This function cancels an outstanding new call added notification request, placed using the NotifyCallAdded() function.
TInt RegisterNotifyCallAdded(const TInt aBufferSize) const;
This function causes the server to create a buffer, specifically for the requesting client, to store the notification that a new call has been added to the line. This buffer ensures that information is not lost between completion of the clients request for notification, and its next request being posted.
const TInt aBufferSize |
The number of events that the server can buffer |
TInt |
An error code: see System error codes. |
TInt DeregisterNotifyCallAdded() const;
This function deletes the buffer in the server. If the client has a Call Added notification still outstanding, it will remain so.
TInt |
An error code: see System error codes. |
The line supports data connections. |
|
The line supports fax connections. |
|
The line supports voice connections. |
|
The line supports incoming call notification requests. |
Line capability flag. Contains a bitmask of the values defined in the TCapsFlags enumeration. |
The name of a call. |
|
The call status. |
|
The call capabilities flag. |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
Rline::TlineNotifyInfo |
Provides structure to contain line capability information. |
etel.h
etel.lib
All the information associated with an instance of the core API line class is collected together into a single, directly accessible, structure to increase the efficiency of those applications which require access to the majority of the lines data.
This class is not intended for user derivation
Rline::TLineNotifyInfo();
The constructor is empty, and is present only to support virtual function table export: see Implications of static DLLs.
RCall::THookStatus iHookStatus |
The current hook status. |
TBool iHookStatusChanged |
An indication that the hook status has changed since the last notification. |
RCall::TStatus iStatus |
The current line status. |
TBool iStatusChanged |
An indication that the line status has changed since the last notification. |
TName iNameOfLastCallAdded |
The name of the last call created on the line. |
TBool iNameOfLastCallAddedChanged |
An indication that a new call has been created on the line and that its name is contained in the iNameOfLastCallAdded member variable. |
TName iNameOfCallForAnswering |
The name of the call to which a new incoming call will be directed. |
TBool iNameOfCallForAnsweringChanged |
An indication that a new call has been assigned to answer the next incoming call. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |