Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_network_reg_info.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: CNetworkRegInfo 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>CNetworkRegInfo Class Reference</h1><!-- doxytag: class="CNetworkRegInfo" --><!-- 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_network_reg_info-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_network_reg_info.html#adff12b8ac65a0bdaf2d6be82b21f1b93">~CNetworkRegInfo</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_network_reg_info.html#a69f884ecb621fc58a85c786b8d627ba0">DoStartRequestL</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_network_reg_info.html#aa058fa58ea14c54734c93e1531698d8c">DoRequestNotificationL</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_network_reg_info.html#a699e05733410059346224352f34134f6">StartRequestL</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_network_reg_info.html#a19c26e7c01ab757451b427a1f2d76c26">RequestNotificationL</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_network_reg_info.html#a69f884ecb621fc58a85c786b8d627ba0">DoStartRequestL</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_network_reg_info.html#aa058fa58ea14c54734c93e1531698d8c">DoRequestNotificationL</a> ()</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_network_reg_info.html">CNetworkRegInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#ac48f97258f5d06a459de3fc2af2c4bb4">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="a45912349859c31d6096f9ea1b1d9d867"></a><!-- doxytag: member="CNetworkRegInfo::NewL" ref="a45912349859c31d6096f9ea1b1d9d867" args="(MExecAsync *aController)" -->
static <a class="el" href="class_c_network_reg_info.html">CNetworkRegInfo</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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45912349859c31d6096f9ea1b1d9d867"></a><!-- doxytag: member="CNetworkRegInfo::NewL" ref="a45912349859c31d6096f9ea1b1d9d867" args="(MExecAsync *aController)" -->
static <a class="el" href="class_c_network_reg_info.html">CNetworkRegInfo</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::TNetworkRegistrationV1&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#aa85225589261df96e8caf34b34054584">iNetworkRegV1</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Obtains the current registration status of the phone. Can be notified on change. </p>

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8h_source.html#l00031">31</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8h_source.html">CNetworkRegInfo.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="adff12b8ac65a0bdaf2d6be82b21f1b93"></a><!-- doxytag: member="CNetworkRegInfo::~CNetworkRegInfo" ref="adff12b8ac65a0bdaf2d6be82b21f1b93" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CNetworkRegInfo::~CNetworkRegInfo </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor. Calls Cancel() to cancel outstanding requests.</p>
<p>Destructor. Cancels outstanding requests.</p>
<p>Destructor. </p>

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

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac48f97258f5d06a459de3fc2af2c4bb4"></a><!-- doxytag: member="CNetworkRegInfo::NewL" ref="ac48f97258f5d06a459de3fc2af2c4bb4" args="(MExecAsync *aController)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_network_reg_info.html">CNetworkRegInfo</a> * CNetworkRegInfo::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_network_reg_info.html">CNetworkRegInfo</a> class </dd></dl>

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

</div>
</div>
<a class="anchor" id="a69f884ecb621fc58a85c786b8d627ba0"></a><!-- doxytag: member="CNetworkRegInfo::DoStartRequestL" ref="a69f884ecb621fc58a85c786b8d627ba0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CNetworkRegInfo::DoStartRequestL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Kicks off request.</p>
<p>Gets the network registration status and stores it in the iNetworkRegV1Pckg package. </p>

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

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8cpp_source.html#l00045">45</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8cpp_source.html">CNetworkRegInfo.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aa058fa58ea14c54734c93e1531698d8c"></a><!-- doxytag: member="CNetworkRegInfo::DoRequestNotificationL" ref="aa058fa58ea14c54734c93e1531698d8c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CNetworkRegInfo::DoRequestNotificationL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Requests to receive notifications of change in the network registration information.</p>
<p>Requests to receive notifications of changes in the network registration status. </p>

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

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8cpp_source.html#l00143">143</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8cpp_source.html">CNetworkRegInfo.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a699e05733410059346224352f34134f6"></a><!-- doxytag: member="CNetworkRegInfo::StartRequestL" ref="a699e05733410059346224352f34134f6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CNetworkRegInfo::StartRequestL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the network registration status and stores it in the iNetworkRegV1Pckg package. </p>

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

<p>Definition at line <a class="el" href="_incoming_calls_2_c_network_reg_info_8cpp_source.html#l00048">48</a> of file <a class="el" href="_incoming_calls_2_c_network_reg_info_8cpp_source.html">CNetworkRegInfo.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a19c26e7c01ab757451b427a1f2d76c26"></a><!-- doxytag: member="CNetworkRegInfo::RequestNotificationL" ref="a19c26e7c01ab757451b427a1f2d76c26" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CNetworkRegInfo::RequestNotificationL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Requests to receive notifications of changes in the network registration status. </p>

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

<p>Definition at line <a class="el" href="_incoming_calls_2_c_network_reg_info_8cpp_source.html#l00139">139</a> of file <a class="el" href="_incoming_calls_2_c_network_reg_info_8cpp_source.html">CNetworkRegInfo.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a69f884ecb621fc58a85c786b8d627ba0"></a><!-- doxytag: member="CNetworkRegInfo::DoStartRequestL" ref="a69f884ecb621fc58a85c786b8d627ba0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CNetworkRegInfo::DoStartRequestL </td>
          <td>(</td>
          <td class="paramname"></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>

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

</div>
</div>
<a class="anchor" id="aa058fa58ea14c54734c93e1531698d8c"></a><!-- doxytag: member="CNetworkRegInfo::DoRequestNotificationL" ref="aa058fa58ea14c54734c93e1531698d8c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CNetworkRegInfo::DoRequestNotificationL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Virtual function for completing the notification request. Empty method. </p>

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

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aa85225589261df96e8caf34b34054584"></a><!-- doxytag: member="CNetworkRegInfo::iNetworkRegV1" ref="aa85225589261df96e8caf34b34054584" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CTelephony::TNetworkRegistrationV1 <a class="el" href="class_c_network_reg_info.html#aa85225589261df96e8caf34b34054584">CNetworkRegInfo::iNetworkRegV1</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Stores the network registration status retrieved.</p>
<p>Stores the retrieved network registration information.</p>
<p>Stores retrieved network registration information. </p>

<p>Definition at line <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8h_source.html#l00053">53</a> of file <a class="el" href="_auto_d_t_m_f_dialler_2_c_network_reg_info_8h_source.html">CNetworkRegInfo.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>