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: CHangup 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>CHangup Class Reference</h1><!-- doxytag: class="CHangup" --><!-- doxytag: inherits="CISVAPIAsync,CISVAPIAsync,CISVAPIAsync" -->
<p>Inherits <a class="el" href="class_c_i_s_v_a_p_i_async.html">CISVAPIAsync</a>, <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_hangup-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hangup.html#ab013511110798db877fb62fbc57ce4ba">~CHangup</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hangup.html#a3a74e216b871816b156431f3ca8388d1">DoStartRequestL</a> (CTelephony::TCallId aCallId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hangup.html#a3a74e216b871816b156431f3ca8388d1">DoStartRequestL</a> (CTelephony::TCallId aCallId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hangup.html#a3a74e216b871816b156431f3ca8388d1">DoStartRequestL</a> (CTelephony::TCallId aCallId)</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_hangup.html">CHangup</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hangup.html#aa8a5bd8e1fc787f1c6960b2806f1b008">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="a67d43dbce55bd225fa809b91c38d622d"></a><!-- doxytag: member="CHangup::NewL" ref="a67d43dbce55bd225fa809b91c38d622d" args="(MExecAsync *aController)" -->
static <a class="el" href="class_c_hangup.html">CHangup</a> * </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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d43dbce55bd225fa809b91c38d622d"></a><!-- doxytag: member="CHangup::NewL" ref="a67d43dbce55bd225fa809b91c38d622d" args="(MExecAsync *aController)" -->
static <a class="el" href="class_c_hangup.html">CHangup</a> * </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hangup.html#ab96d71c46eaad03f7fd419f261141e8d">iCallId</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Hang up the currently active call whose callId is specified as an argument to <a class="el" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL()</a></p>
<p>Hangs up the current active call with the callId specified as an argument to <a class="el" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL()</a>.</p>
<p>Hangs up the currently active call with the callId specified 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_hangup_8h_source.html#l00030">30</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_hangup_8h_source.html">CHangup.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab013511110798db877fb62fbc57ce4ba"></a><!-- doxytag: member="CHangup::~CHangup" ref="ab013511110798db877fb62fbc57ce4ba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CHangup::~CHangup </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. Cancels 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_hangup_8cpp_source.html#l00037">37</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_hangup_8cpp_source.html">CHangup.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa8a5bd8e1fc787f1c6960b2806f1b008"></a><!-- doxytag: member="CHangup::NewL" ref="aa8a5bd8e1fc787f1c6960b2806f1b008" args="(MExecAsync *aController)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_hangup.html">CHangup</a> * CHangup::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_exec_async.html">MExecAsync</a> * </td>
<td class="paramname"> <em>aController</em></td>
<td> ) </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> </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_hangup.html">CHangup</a> class </dd></dl>
<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_hangup_8cpp_source.html#l00024">24</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_hangup_8cpp_source.html">CHangup.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3a74e216b871816b156431f3ca8388d1"></a><!-- doxytag: member="CHangup::DoStartRequestL" ref="a3a74e216b871816b156431f3ca8388d1" args="(CTelephony::TCallId aCallId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHangup::DoStartRequestL </td>
<td>(</td>
<td class="paramtype">CTelephony::TCallId </td>
<td class="paramname"> <em>aCallId</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hangs up call specified in aCallId. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aCallId</em> </td><td>Call ID of call to hang up</td></tr>
</table>
</dd>
</dl>
<p>Hangs up the call specified in aCallId.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aCallId</em> </td><td>Call ID of call to hang up </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a5c7370075e9ef466a25cb188cbf0f15c">CISVAPIBase</a>.</p>
<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_hangup_8cpp_source.html#l00046">46</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_hangup_8cpp_source.html">CHangup.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3a74e216b871816b156431f3ca8388d1"></a><!-- doxytag: member="CHangup::DoStartRequestL" ref="a3a74e216b871816b156431f3ca8388d1" args="(CTelephony::TCallId aCallId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHangup::DoStartRequestL </td>
<td>(</td>
<td class="paramtype">CTelephony::TCallId </td>
<td class="paramname"> <em>aCallId</em></td>
<td> ) </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>aCallId</em> </td><td>A call identifier to perform Etel Third Party operations on </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a5c7370075e9ef466a25cb188cbf0f15c">CISVAPIBase</a>.</p>
</div>
</div>
<a class="anchor" id="a3a74e216b871816b156431f3ca8388d1"></a><!-- doxytag: member="CHangup::DoStartRequestL" ref="a3a74e216b871816b156431f3ca8388d1" args="(CTelephony::TCallId aCallId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHangup::DoStartRequestL </td>
<td>(</td>
<td class="paramtype">CTelephony::TCallId </td>
<td class="paramname"> <em>aCallId</em></td>
<td> ) </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>aCallId</em> </td><td>A call identifier to perform Etel Third Party operations on </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a5c7370075e9ef466a25cb188cbf0f15c">CISVAPIBase</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab96d71c46eaad03f7fd419f261141e8d"></a><!-- doxytag: member="CHangup::iCallId" ref="ab96d71c46eaad03f7fd419f261141e8d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTelephony::TCallId <a class="el" href="class_c_hangup.html#ab96d71c46eaad03f7fd419f261141e8d">CHangup::iCallId</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The call identifier of the call to be hung up. </p>
<p>Definition at line <a class="el" href="_incoming_calls_2_c_hangup_8h_source.html#l00054">54</a> of file <a class="el" href="_incoming_calls_2_c_hangup_8h_source.html">CHangup.h</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>