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: CHold 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>CHold Class Reference</h1><!-- doxytag: class="CHold" --><!-- doxytag: inherits="CISVAPIAsync" -->
<p>Inherits <a class="el" href="class_c_i_s_v_a_p_i_async.html">CISVAPIAsync</a>.</p>
<p><a href="class_c_hold-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_hold.html#a9886f0a98bd9b741bf01680cba14eac2">~CHold</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hold.html#a699583a9dca9faaa89895a22e9f09821">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_hold.html">CHold</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hold.html#a5ea9765db83d29f6eeff7f7cffb7b6ec">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Puts the currently active call specified as an argument to <a class="el" href="class_c_i_s_v_a_p_i_base.html#af5a272546d704790a27788fcd45598b5">DoStartRequestL()</a> on hold. </p>
<p>Definition at line <a class="el" href="_c_hold_8h_source.html#l00032">32</a> of file <a class="el" href="_c_hold_8h_source.html">CHold.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9886f0a98bd9b741bf01680cba14eac2"></a><!-- doxytag: member="CHold::~CHold" ref="a9886f0a98bd9b741bf01680cba14eac2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CHold::~CHold </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. Cancels outstanding requests. </p>
<p>Definition at line <a class="el" href="_c_hold_8cpp_source.html#l00039">39</a> of file <a class="el" href="_c_hold_8cpp_source.html">CHold.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5ea9765db83d29f6eeff7f7cffb7b6ec"></a><!-- doxytag: member="CHold::NewL" ref="a5ea9765db83d29f6eeff7f7cffb7b6ec" args="(MExecAsync *aController)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_hold.html">CHold</a> * CHold::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_hold.html">CHold</a> class </dd></dl>
<p>Definition at line <a class="el" href="_c_hold_8cpp_source.html#l00026">26</a> of file <a class="el" href="_c_hold_8cpp_source.html">CHold.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a699583a9dca9faaa89895a22e9f09821"></a><!-- doxytag: member="CHold::DoStartRequestL" ref="a699583a9dca9faaa89895a22e9f09821" args="(CTelephony::TCallId aCallId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CHold::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>Holds a call if the dynamic capabilities allow it.</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>The identifier of the call to put on hold </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="_c_hold_8cpp_source.html#l00049">49</a> of file <a class="el" href="_c_hold_8cpp_source.html">CHold.cpp</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>