Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_hold.html
changeset 6 43e37759235e
parent 1 25a17d01db0c
equal deleted inserted replaced
5:f345bda72bc4 6:43e37759235e
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
     1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
     2 <html xmlns="http://www.w3.org/1999/xhtml">
     3 <title>TB10.1 Example Applications: CHold Class Reference</title>
     3 <head>
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
     4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
     5 <title>TB9.2 Example Applications: CHold Class Reference</title>
     6 </head><body>
     6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
     7 <!-- Generated by Doxygen 1.5.3 -->
     7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
     8 <h1>CHold Class Reference</h1><!-- doxytag: class="CHold" --><!-- doxytag: inherits="CISVAPIAsync" --><div class="dynheader">
     8 </head>
     9 Inheritance diagram for CHold:</div>
     9 <body>
    10 <div class="dynsection">
    10 <!-- Generated by Doxygen 1.6.2 -->
       
    11 <div class="contents">
       
    12 <h1>CHold Class Reference</h1><!-- doxytag: class="CHold" --><!-- doxytag: inherits="CISVAPIAsync" -->
       
    13 <p>Inherits <a class="el" href="class_c_i_s_v_a_p_i_async.html">CISVAPIAsync</a>.</p>
    11 
    14 
    12 <p><center><img src="class_c_hold.png" usemap="#CHold_map" border="0" alt=""></center>
    15 <p><a href="class_c_hold-members.html">List of all members.</a></p>
    13 <map name="CHold_map">
    16 <table border="0" cellpadding="0" cellspacing="0">
    14 <area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="0,56,97,80">
    17 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
    15 <area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="0,0,97,24">
    18 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hold.html#a9886f0a98bd9b741bf01680cba14eac2">~CHold</a> ()</td></tr>
    16 </map>
    19 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hold.html#a699583a9dca9faaa89895a22e9f09821">DoStartRequestL</a> (CTelephony::TCallId aCallId)</td></tr>
    17 </div>
    20 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
       
    21 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_hold.html">CHold</a> *&nbsp;</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>
       
    22 </table>
       
    23 <hr/><a name="_details"></a><h2>Detailed Description</h2>
       
    24 <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>
    18 
    25 
    19 <p>
    26 <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>
    20 <a href="class_c_hold-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
    27 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
    21 <tr><td></td></tr>
    28 <a class="anchor" id="a9886f0a98bd9b741bf01680cba14eac2"></a><!-- doxytag: member="CHold::~CHold" ref="a9886f0a98bd9b741bf01680cba14eac2" args="()" -->
    22 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
       
    23 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hold.html#9886f0a98bd9b741bf01680cba14eac2">~CHold</a> ()</td></tr>
       
    24 
       
    25 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hold.html#699583a9dca9faaa89895a22e9f09821">DoStartRequestL</a> (CTelephony::TCallId aCallId)</td></tr>
       
    26 
       
    27 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
       
    28 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_hold.html">CHold</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_hold.html#5ea9765db83d29f6eeff7f7cffb7b6ec">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>
       
    29 
       
    30 </table>
       
    31 <hr><a name="_details"></a><h2>Detailed Description</h2>
       
    32 Puts the currently active call specified as an argument to <a class="el" href="class_c_i_s_v_a_p_i_base.html#f5a272546d704790a27788fcd45598b5">DoStartRequestL()</a> on hold. 
       
    33 <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>
       
    34 <hr><h2>Constructor &amp; Destructor Documentation</h2>
       
    35 <a class="anchor" name="9886f0a98bd9b741bf01680cba14eac2"></a><!-- doxytag: member="CHold::~CHold" ref="9886f0a98bd9b741bf01680cba14eac2" args="()" -->
       
    36 <div class="memitem">
    29 <div class="memitem">
    37 <div class="memproto">
    30 <div class="memproto">
    38       <table class="memname">
    31       <table class="memname">
    39         <tr>
    32         <tr>
    40           <td class="memname">CHold::~CHold           </td>
    33           <td class="memname">CHold::~CHold </td>
    41           <td>(</td>
    34           <td>(</td>
    42           <td class="paramname">          </td>
    35           <td class="paramname"></td>
    43           <td>&nbsp;)&nbsp;</td>
    36           <td>&nbsp;)&nbsp;</td>
    44           <td width="100%"></td>
    37           <td></td>
    45         </tr>
    38         </tr>
    46       </table>
    39       </table>
    47 </div>
    40 </div>
    48 <div class="memdoc">
    41 <div class="memdoc">
       
    42 <p>Destructor. Cancels outstanding requests. </p>
    49 
    43 
    50 <p>
    44 <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>
    51 Destructor. Cancels outstanding requests. 
       
    52 <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>
       
    53 
    45 
    54 </div>
    46 </div>
    55 </div><p>
    47 </div>
    56 <hr><h2>Member Function Documentation</h2>
    48 <hr/><h2>Member Function Documentation</h2>
    57 <a class="anchor" name="5ea9765db83d29f6eeff7f7cffb7b6ec"></a><!-- doxytag: member="CHold::NewL" ref="5ea9765db83d29f6eeff7f7cffb7b6ec" args="(MExecAsync *aController)" -->
    49 <a class="anchor" id="a5ea9765db83d29f6eeff7f7cffb7b6ec"></a><!-- doxytag: member="CHold::NewL" ref="a5ea9765db83d29f6eeff7f7cffb7b6ec" args="(MExecAsync *aController)" -->
    58 <div class="memitem">
    50 <div class="memitem">
    59 <div class="memproto">
    51 <div class="memproto">
    60       <table class="memname">
    52       <table class="memname">
    61         <tr>
    53         <tr>
    62           <td class="memname"><a class="el" href="class_c_hold.html">CHold</a> * CHold::NewL           </td>
    54           <td class="memname"><a class="el" href="class_c_hold.html">CHold</a> * CHold::NewL </td>
    63           <td>(</td>
    55           <td>(</td>
    64           <td class="paramtype"><a class="el" href="class_m_exec_async.html">MExecAsync</a> *&nbsp;</td>
    56           <td class="paramtype"><a class="el" href="class_m_exec_async.html">MExecAsync</a> *&nbsp;</td>
    65           <td class="paramname"> <em>aController</em>          </td>
    57           <td class="paramname"> <em>aController</em></td>
    66           <td>&nbsp;)&nbsp;</td>
    58           <td>&nbsp;)&nbsp;</td>
    67           <td width="100%"><code> [static]</code></td>
    59           <td><code> [static]</code></td>
    68         </tr>
    60         </tr>
    69       </table>
    61       </table>
    70 </div>
    62 </div>
    71 <div class="memdoc">
    63 <div class="memdoc">
    72 
    64 <p>Factory constructor.</p>
    73 <p>
    65 <dl><dt><b>Parameters:</b></dt><dd>
    74 Factory constructor.<p>
       
    75 <dl compact><dt><b>Parameters:</b></dt><dd>
       
    76   <table border="0" cellspacing="2" cellpadding="0">
    66   <table border="0" cellspacing="2" cellpadding="0">
    77     <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>
    67     <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>
    78   </table>
    68   </table>
       
    69   </dd>
    79 </dl>
    70 </dl>
    80 <dl class="return" compact><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_hold.html">CHold</a> class </dd></dl>
    71 <dl class="return"><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_hold.html">CHold</a> class </dd></dl>
    81 
    72 
    82 <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>
    73 <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>
    83 
    74 
    84 </div>
    75 </div>
    85 </div><p>
    76 </div>
    86 <a class="anchor" name="699583a9dca9faaa89895a22e9f09821"></a><!-- doxytag: member="CHold::DoStartRequestL" ref="699583a9dca9faaa89895a22e9f09821" args="(CTelephony::TCallId aCallId)" -->
    77 <a class="anchor" id="a699583a9dca9faaa89895a22e9f09821"></a><!-- doxytag: member="CHold::DoStartRequestL" ref="a699583a9dca9faaa89895a22e9f09821" args="(CTelephony::TCallId aCallId)" -->
    87 <div class="memitem">
    78 <div class="memitem">
    88 <div class="memproto">
    79 <div class="memproto">
    89       <table class="memname">
    80       <table class="memname">
    90         <tr>
    81         <tr>
    91           <td class="memname">void CHold::DoStartRequestL           </td>
    82           <td class="memname">void CHold::DoStartRequestL </td>
    92           <td>(</td>
    83           <td>(</td>
    93           <td class="paramtype">CTelephony::TCallId&nbsp;</td>
    84           <td class="paramtype">CTelephony::TCallId&nbsp;</td>
    94           <td class="paramname"> <em>aCallId</em>          </td>
    85           <td class="paramname"> <em>aCallId</em></td>
    95           <td>&nbsp;)&nbsp;</td>
    86           <td>&nbsp;)&nbsp;</td>
    96           <td width="100%"><code> [virtual]</code></td>
    87           <td><code> [virtual]</code></td>
    97         </tr>
    88         </tr>
    98       </table>
    89       </table>
    99 </div>
    90 </div>
   100 <div class="memdoc">
    91 <div class="memdoc">
   101 
    92 <p>Holds a call if the dynamic capabilities allow it.</p>
   102 <p>
    93 <dl><dt><b>Parameters:</b></dt><dd>
   103 Holds a call if the dynamic capabilities allow it.<p>
       
   104 <dl compact><dt><b>Parameters:</b></dt><dd>
       
   105   <table border="0" cellspacing="2" cellpadding="0">
    94   <table border="0" cellspacing="2" cellpadding="0">
   106     <tr><td valign="top"></td><td valign="top"><em>aCallId</em>&nbsp;</td><td>The identifier of the call to put on hold </td></tr>
    95     <tr><td valign="top"></td><td valign="top"><em>aCallId</em>&nbsp;</td><td>The identifier of the call to put on hold </td></tr>
   107   </table>
    96   </table>
       
    97   </dd>
   108 </dl>
    98 </dl>
   109 
    99 
   110 <p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#5c7370075e9ef466a25cb188cbf0f15c">CISVAPIBase</a>.</p>
   100 <p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#a5c7370075e9ef466a25cb188cbf0f15c">CISVAPIBase</a>.</p>
   111 
   101 
   112 <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>
   102 <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>
   113 
   103 
   114 </div>
   104 </div>
   115 </div><p>
   105 </div>
   116 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:05 2010 for TB10.1 Example Applications by&nbsp;
   106 </div>
       
   107 <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
   117 <a href="http://www.doxygen.org/index.html">
   108 <a href="http://www.doxygen.org/index.html">
   118 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
   109 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
   119 </body>
   110 </body>
   120 </html>
   111 </html>