Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_call_status.html
changeset 1 25a17d01db0c
child 6 43e37759235e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_call_status.html	Fri Jan 22 18:26:19 2010 +0000
@@ -0,0 +1,304 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>TB10.1 Example Applications: CCallStatus Class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.3 -->
+<h1>CCallStatus Class Reference</h1><!-- doxytag: class="CCallStatus" --><!-- doxytag: inherits="CISVAPIAsync,CISVAPIAsync,CISVAPIAsync" --><div class="dynheader">
+Inheritance diagram for CCallStatus:</div>
+<div class="dynsection">
+
+<p><center><img src="class_c_call_status.png" usemap="#CCallStatus_map" border="0" alt=""></center>
+<map name="CCallStatus_map">
+<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="0,56,97,80">
+<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="107,56,204,80">
+<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="214,56,311,80">
+<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="0,0,97,24">
+<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="107,0,204,24">
+<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="214,0,311,24">
+</map>
+</div>
+
+<p>
+<a href="class_c_call_status-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#0daa174ea163f28acbf032cf17db64d5">~CCallStatus</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#1080ab5dc4eb292b5027628ae0c7c1c2">DoStartRequestL</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#0ffceba0961982fa1d4e474fdf91cf93">DoRequestNotificationL</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#1080ab5dc4eb292b5027628ae0c7c1c2">DoStartRequestL</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#0ffceba0961982fa1d4e474fdf91cf93">DoRequestNotificationL</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#1080ab5dc4eb292b5027628ae0c7c1c2">DoStartRequestL</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#0ffceba0961982fa1d4e474fdf91cf93">DoRequestNotificationL</a> ()</td></tr>
+
+<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_call_status.html">CCallStatus</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#cd6e841da4cf8f5a963d18aac083848f">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController, CTelephony::TCallId aCallId)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35f961137d5a93fe86da0ac85f6465cf"></a><!-- doxytag: member="CCallStatus::NewL" ref="35f961137d5a93fe86da0ac85f6465cf" args="(MExecAsync *aController, CTelephony::TCallId aCallId)" -->
+static <a class="el" href="class_c_call_status.html">CCallStatus</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>NewL</b> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController, CTelephony::TCallId aCallId)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35f961137d5a93fe86da0ac85f6465cf"></a><!-- doxytag: member="CCallStatus::NewL" ref="35f961137d5a93fe86da0ac85f6465cf" args="(MExecAsync *aController, CTelephony::TCallId aCallId)" -->
+static <a class="el" href="class_c_call_status.html">CCallStatus</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>NewL</b> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController, CTelephony::TCallId aCallId)</td></tr>
+
+<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony::TCallId&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#42e91cb944e52b18bf732968e2369ae4">iCallId</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony::TCallStatusV1&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_call_status.html#2c1964936f47092bc8701103377646f7">iCallStatusV1</a></td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Retrieves data pertaining to the current status of the call specified by iCallId. Can be notified on change.<p>
+Retrieves data pertaining to the current status of the call specified by iCallId. Can be notified on change. 
+<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8h-source.html#l00031">31</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8h-source.html">CCallStatus.h</a>.</p>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="0daa174ea163f28acbf032cf17db64d5"></a><!-- doxytag: member="CCallStatus::~CCallStatus" ref="0daa174ea163f28acbf032cf17db64d5" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">CCallStatus::~CCallStatus           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Destructor. Cancels outstanding requests.<p>
+Destructor. Cancels outstanding requests. 
+<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html#l00039">39</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html">CCallStatus.cpp</a>.</p>
+
+</div>
+</div><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="cd6e841da4cf8f5a963d18aac083848f"></a><!-- doxytag: member="CCallStatus::NewL" ref="cd6e841da4cf8f5a963d18aac083848f" args="(MExecAsync *aController, CTelephony::TCallId aCallId)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="class_c_call_status.html">CCallStatus</a> * CCallStatus::NewL           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="class_m_exec_async.html">MExecAsync</a> *&nbsp;</td>
+          <td class="paramname"> <em>aController</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CTelephony::TCallId&nbsp;</td>
+          <td class="paramname"> <em>aCallId</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Factory constructor.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>aController</em>&nbsp;</td><td>Pointer to <a class="el" href="class_m_exec_async.html">MExecAsync</a> object passed to constructor of <a class="el" href="class_c_i_s_v_a_p_i_base.html">CISVAPIBase</a> </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>aCallId</em>&nbsp;</td><td>Caller ID to retrieve the status </td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_call_status.html">CCallStatus</a> class</dd></dl>
+Factory constructor.<p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>aController</em>&nbsp;</td><td>Pointer to <a class="el" href="class_m_exec_async.html">MExecAsync</a> object passed to constructor of <a class="el" href="class_c_i_s_v_a_p_i_base.html">CISVAPIBase</a> </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>aCallId</em>&nbsp;</td><td>Caller ID to retrieve the status </td></tr>
+  </table>
+</dl>
+<dl class="return" compact><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_call_status.html">CCallStatus</a> class </dd></dl>
+
+<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html#l00027">27</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html">CCallStatus.cpp</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="1080ab5dc4eb292b5027628ae0c7c1c2"></a><!-- doxytag: member="CCallStatus::DoStartRequestL" ref="1080ab5dc4eb292b5027628ae0c7c1c2" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CCallStatus::DoStartRequestL           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Gets the call status of the call specified in iCallId and displays output to console.<p>
+Gets the current call status, stores it in the iCallStatusV1Pckg package and prints it to the console. 
+<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#f5a272546d704790a27788fcd45598b5">CISVAPIBase</a>.</p>
+
+<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html#l00048">48</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html">CCallStatus.cpp</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="0ffceba0961982fa1d4e474fdf91cf93"></a><!-- doxytag: member="CCallStatus::DoRequestNotificationL" ref="0ffceba0961982fa1d4e474fdf91cf93" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CCallStatus::DoRequestNotificationL           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Registers interest in receiving change notifications of the call status by calling CTelephony::NotifyChange.<p>
+Requests to receive notifications of change in the call status 
+<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#0c13d9526d07940b6c8f6504e6e2c559">CISVAPIBase</a>.</p>
+
+<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html#l00179">179</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8cpp-source.html">CCallStatus.cpp</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="1080ab5dc4eb292b5027628ae0c7c1c2"></a><!-- doxytag: member="CCallStatus::DoStartRequestL" ref="1080ab5dc4eb292b5027628ae0c7c1c2" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CCallStatus::DoStartRequestL           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Virtual function for completing the request to start. Empty method. 
+<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#f5a272546d704790a27788fcd45598b5">CISVAPIBase</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="0ffceba0961982fa1d4e474fdf91cf93"></a><!-- doxytag: member="CCallStatus::DoRequestNotificationL" ref="0ffceba0961982fa1d4e474fdf91cf93" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CCallStatus::DoRequestNotificationL           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Virtual function for completing the notification request. Empty method. 
+<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#0c13d9526d07940b6c8f6504e6e2c559">CISVAPIBase</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="1080ab5dc4eb292b5027628ae0c7c1c2"></a><!-- doxytag: member="CCallStatus::DoStartRequestL" ref="1080ab5dc4eb292b5027628ae0c7c1c2" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CCallStatus::DoStartRequestL           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Virtual function for completing the request to start. Empty method. 
+<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#f5a272546d704790a27788fcd45598b5">CISVAPIBase</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="0ffceba0961982fa1d4e474fdf91cf93"></a><!-- doxytag: member="CCallStatus::DoRequestNotificationL" ref="0ffceba0961982fa1d4e474fdf91cf93" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CCallStatus::DoRequestNotificationL           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Virtual function for completing the notification request. Empty method. 
+<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#0c13d9526d07940b6c8f6504e6e2c559">CISVAPIBase</a>.</p>
+
+</div>
+</div><p>
+<hr><h2>Member Data Documentation</h2>
+<a class="anchor" name="42e91cb944e52b18bf732968e2369ae4"></a><!-- doxytag: member="CCallStatus::iCallId" ref="42e91cb944e52b18bf732968e2369ae4" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">CTelephony::TCallId <a class="el" href="class_c_call_status.html#42e91cb944e52b18bf732968e2369ae4">CCallStatus::iCallId</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Identifies the call whose status will be retrieved.<p>
+The call whose status will be interrogated. 
+<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8h-source.html#l00053">53</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8h-source.html">CCallStatus.h</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="2c1964936f47092bc8701103377646f7"></a><!-- doxytag: member="CCallStatus::iCallStatusV1" ref="2c1964936f47092bc8701103377646f7" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">CTelephony::TCallStatusV1 <a class="el" href="class_c_call_status.html#2c1964936f47092bc8701103377646f7">CCallStatus::iCallStatusV1</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Stores the call status of iCallId.<p>
+Stores retrieved call status of iCallId. 
+<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8h-source.html#l00057">57</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_call_status_8h-source.html">CCallStatus.h</a>.</p>
+
+</div>
+</div><p>
+<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
+</body>
+</html>