Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_current_network_info.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Fri, 22 Jan 2010 18:26:19 +0000
changeset 1 25a17d01db0c
child 6 43e37759235e
permissions -rw-r--r--
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608

<!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: CCurrentNetworkInfo 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>CCurrentNetworkInfo Class Reference</h1><!-- doxytag: class="CCurrentNetworkInfo" --><!-- doxytag: inherits="CISVAPIAsync,CISVAPIAsync" --><div class="dynheader">
Inheritance diagram for CCurrentNetworkInfo:</div>
<div class="dynsection">

<p><center><img src="class_c_current_network_info.png" usemap="#CCurrentNetworkInfo_map" border="0" alt=""></center>
<map name="CCurrentNetworkInfo_map">
<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="0,56,131,80">
<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="141,56,272,80">
<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="0,0,131,24">
<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="141,0,272,24">
</map>
</div>

<p>
<a href="class_c_current_network_info-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_current_network_info.html#b880e47a5b178ab198dc1682afc6c82c">~CCurrentNetworkInfo</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_current_network_info.html#cc30835222a78d45216de7a1c66086d6">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_current_network_info.html#d2c9d6cb31df024113fcf2180b4e336b">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_current_network_info.html#cc30835222a78d45216de7a1c66086d6">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_current_network_info.html#d2c9d6cb31df024113fcf2180b4e336b">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 <br>
<a class="el" href="class_c_current_network_info.html">CCurrentNetworkInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_current_network_info.html#4986bb618dc938a9f49530cf2c8d10da">NewL</a> (<a class="el" href="class_m_exec_async.html">MExecAsync</a> *aController)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bdd08e01112b8199449d5f44c1bdea33"></a><!-- doxytag: member="CCurrentNetworkInfo::NewL" ref="bdd08e01112b8199449d5f44c1bdea33" args="(MExecAsync *aController)" -->
static <br>
<a class="el" href="class_c_current_network_info.html">CCurrentNetworkInfo</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"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony::TNetworkInfoV1&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_current_network_info.html#7189a52416be5e9768a6ccfcc4f58020">iCurrentNetworkInfoV1</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Retrieves information about the current network including Cell ID and the current area code. Can be notified on change.<p>
Retrieves information about the current network including Cell ID and current area code. Can be notified on change. 
<p>Definition at line <a class="el" href="_network_information_2_c_current_network_info_8h-source.html#l00033">33</a> of file <a class="el" href="_network_information_2_c_current_network_info_8h-source.html">CCurrentNetworkInfo.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b880e47a5b178ab198dc1682afc6c82c"></a><!-- doxytag: member="CCurrentNetworkInfo::~CCurrentNetworkInfo" ref="b880e47a5b178ab198dc1682afc6c82c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CCurrentNetworkInfo::~CCurrentNetworkInfo           </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>Definition at line <a class="el" href="_network_information_2_c_current_network_info_8cpp-source.html#l00039">39</a> of file <a class="el" href="_network_information_2_c_current_network_info_8cpp-source.html">CCurrentNetworkInfo.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4986bb618dc938a9f49530cf2c8d10da"></a><!-- doxytag: member="CCurrentNetworkInfo::NewL" ref="4986bb618dc938a9f49530cf2c8d10da" args="(MExecAsync *aController)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_current_network_info.html">CCurrentNetworkInfo</a> * CCurrentNetworkInfo::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 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>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Instance of <a class="el" href="class_c_current_network_info.html">CCurrentNetworkInfo</a> class </dd></dl>

<p>Definition at line <a class="el" href="_network_information_2_c_current_network_info_8cpp-source.html#l00026">26</a> of file <a class="el" href="_network_information_2_c_current_network_info_8cpp-source.html">CCurrentNetworkInfo.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="cc30835222a78d45216de7a1c66086d6"></a><!-- doxytag: member="CCurrentNetworkInfo::DoStartRequestL" ref="cc30835222a78d45216de7a1c66086d6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CCurrentNetworkInfo::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 current network information and stores it in the iCurrentNetworkInfoV1Pckg package. 
<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="_network_information_2_c_current_network_info_8cpp-source.html#l00048">48</a> of file <a class="el" href="_network_information_2_c_current_network_info_8cpp-source.html">CCurrentNetworkInfo.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="d2c9d6cb31df024113fcf2180b4e336b"></a><!-- doxytag: member="CCurrentNetworkInfo::DoRequestNotificationL" ref="d2c9d6cb31df024113fcf2180b4e336b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CCurrentNetworkInfo::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>
Requests to receive notifications of change in the current network information. 
<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="_network_information_2_c_current_network_info_8cpp-source.html#l00140">140</a> of file <a class="el" href="_network_information_2_c_current_network_info_8cpp-source.html">CCurrentNetworkInfo.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="cc30835222a78d45216de7a1c66086d6"></a><!-- doxytag: member="CCurrentNetworkInfo::DoStartRequestL" ref="cc30835222a78d45216de7a1c66086d6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CCurrentNetworkInfo::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="d2c9d6cb31df024113fcf2180b4e336b"></a><!-- doxytag: member="CCurrentNetworkInfo::DoRequestNotificationL" ref="d2c9d6cb31df024113fcf2180b4e336b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CCurrentNetworkInfo::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="7189a52416be5e9768a6ccfcc4f58020"></a><!-- doxytag: member="CCurrentNetworkInfo::iCurrentNetworkInfoV1" ref="7189a52416be5e9768a6ccfcc4f58020" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CTelephony::TNetworkInfoV1 <a class="el" href="class_c_current_network_info.html#7189a52416be5e9768a6ccfcc4f58020">CCurrentNetworkInfo::iCurrentNetworkInfoV1</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Stores retrieved network information. 
<p>Definition at line <a class="el" href="_network_information_2_c_current_network_info_8h-source.html#l00056">56</a> of file <a class="el" href="_network_information_2_c_current_network_info_8h-source.html">CCurrentNetworkInfo.h</a>.</p>

</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:04 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>