Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_dial_call.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: CDialCall Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CDialCall Class Reference</h1><!-- doxytag: class="CDialCall" --><!-- doxytag: inherits="CISVAPIAsync,CISVAPIAsync" -->
<p>Inherits <a class="el" href="class_c_i_s_v_a_p_i_async.html">CISVAPIAsync</a>, and <a class="el" href="class_c_i_s_v_a_p_i_async.html">CISVAPIAsync</a>.</p>

<p><a href="class_c_dial_call-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_dial_call.html#a60585ab5b96b51a3a2c05e70c3386c7d">~CDialCall</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_dial_call.html#a6802972dcfe35127ea302b7d5a531b92">DoStartRequestL</a> (const TDesC &amp;aNumber)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_dial_call.html#a6802972dcfe35127ea302b7d5a531b92">DoStartRequestL</a> (const TDesC &amp;aNumber)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_dial_call.html">CDialCall</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_dial_call.html#a77f2cdc72ec6c48f160ee3cb3f40fbc7">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a684f3b4b11a7a40e62cfb75ed98aaae9"></a><!-- doxytag: member="CDialCall::NewL" ref="a684f3b4b11a7a40e62cfb75ed98aaae9" args="(MExecAsync *aController)" -->
static <a class="el" href="class_c_dial_call.html">CDialCall</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>NewL</b> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CTelephony::TCallId&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_dial_call.html#a7f7be08462f0caf2ebb4ee4814a15623">iCallId</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Dials a call to the number passed as an argument to <a class="el" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL()</a>.</p>
<p>Dials a call to the specifed number taken as an argument to <a class="el" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL()</a> </p>

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8h_source.html#l00030">30</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8h_source.html">CDialCall.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a60585ab5b96b51a3a2c05e70c3386c7d"></a><!-- doxytag: member="CDialCall::~CDialCall" ref="a60585ab5b96b51a3a2c05e70c3386c7d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CDialCall::~CDialCall </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor. Cancels any outstanding requests.</p>
<p>Destructor. Cancels outstanding requests. </p>

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8cpp_source.html#l00037">37</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8cpp_source.html">CDialCall.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a77f2cdc72ec6c48f160ee3cb3f40fbc7"></a><!-- doxytag: member="CDialCall::NewL" ref="a77f2cdc72ec6c48f160ee3cb3f40fbc7" args="(MExecAsync *aController)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_dial_call.html">CDialCall</a> * CDialCall::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>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Factory constructor.</p>
<dl><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>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_dial_call.html">CDialCall</a> class </dd></dl>

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8cpp_source.html#l00025">25</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8cpp_source.html">CDialCall.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6802972dcfe35127ea302b7d5a531b92"></a><!-- doxytag: member="CDialCall::DoStartRequestL" ref="a6802972dcfe35127ea302b7d5a531b92" args="(const TDesC &amp;aNumber)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CDialCall::DoStartRequestL </td>
          <td>(</td>
          <td class="paramtype">const TDesC &amp;&nbsp;</td>
          <td class="paramname"> <em>aNumber</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the required parameters and starts dialling the call.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aNumber</em>&nbsp;</td><td>Phone number to dial.</td></tr>
  </table>
  </dd>
</dl>
<p>Makes a call to aNumber.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aNumber</em>&nbsp;</td><td>The number to dial </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a0b7e14a686bfae70e3a0ef187e2bcf01">CISVAPIBase</a>.</p>

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8cpp_source.html#l00047">47</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8cpp_source.html">CDialCall.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6802972dcfe35127ea302b7d5a531b92"></a><!-- doxytag: member="CDialCall::DoStartRequestL" ref="a6802972dcfe35127ea302b7d5a531b92" args="(const TDesC &amp;aNumber)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CDialCall::DoStartRequestL </td>
          <td>(</td>
          <td class="paramtype">const TDesC &amp;&nbsp;</td>
          <td class="paramname"> <em>aNumber</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Virtual function for completing the request to start. Empty method.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aNumber</em>&nbsp;</td><td>Number to be used </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a0b7e14a686bfae70e3a0ef187e2bcf01">CISVAPIBase</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a7f7be08462f0caf2ebb4ee4814a15623"></a><!-- doxytag: member="CDialCall::iCallId" ref="a7f7be08462f0caf2ebb4ee4814a15623" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CTelephony::TCallId <a class="el" href="class_c_dial_call.html#a7f7be08462f0caf2ebb4ee4814a15623">CDialCall::iCallId</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The ID of the call which will be made.</p>
<p>Identifies the dialled call. </p>

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8h_source.html#l00052">52</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_dial_call_8h_source.html">CDialCall.h</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>