Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_network_reg_info.html
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: CNetworkRegInfo 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>CNetworkRegInfo Class Reference</h1><!-- doxytag: class="CNetworkRegInfo" --><!-- doxytag: inherits="CISVAPIAsync,CISVAPIAsync,CISVAPIAsync" --><div class="dynheader">
Inheritance diagram for CNetworkRegInfo:</div>
<div class="dynsection">
<p><center><img src="class_c_network_reg_info.png" usemap="#CNetworkRegInfo_map" border="0" alt=""></center>
<map name="CNetworkRegInfo_map">
<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="0,56,110,80">
<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="120,56,230,80">
<area href="class_c_i_s_v_a_p_i_async.html" alt="CISVAPIAsync" shape="rect" coords="240,56,350,80">
<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="0,0,110,24">
<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="120,0,230,24">
<area href="class_c_i_s_v_a_p_i_base.html" alt="CISVAPIBase" shape="rect" coords="240,0,350,24">
</map>
</div>
<p>
<a href="class_c_network_reg_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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#dff12b8ac65a0bdaf2d6be82b21f1b93">~CNetworkRegInfo</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#69f884ecb621fc58a85c786b8d627ba0">DoStartRequestL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#a058fa58ea14c54734c93e1531698d8c">DoRequestNotificationL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#699e05733410059346224352f34134f6">StartRequestL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#19c26e7c01ab757451b427a1f2d76c26">RequestNotificationL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#69f884ecb621fc58a85c786b8d627ba0">DoStartRequestL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#a058fa58ea14c54734c93e1531698d8c">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 <a class="el" href="class_c_network_reg_info.html">CNetworkRegInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#c48f97258f5d06a459de3fc2af2c4bb4">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="45912349859c31d6096f9ea1b1d9d867"></a><!-- doxytag: member="CNetworkRegInfo::NewL" ref="45912349859c31d6096f9ea1b1d9d867" args="(MExecAsync *aController)" -->
static <a class="el" href="class_c_network_reg_info.html">CNetworkRegInfo</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" nowrap align="right" valign="top"><a class="anchor" name="45912349859c31d6096f9ea1b1d9d867"></a><!-- doxytag: member="CNetworkRegInfo::NewL" ref="45912349859c31d6096f9ea1b1d9d867" args="(MExecAsync *aController)" -->
static <a class="el" href="class_c_network_reg_info.html">CNetworkRegInfo</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"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CTelephony::TNetworkRegistrationV1 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_network_reg_info.html#a85225589261df96e8caf34b34054584">iNetworkRegV1</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Obtains the current registration status of the phone. Can be notified on change.
<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 & Destructor Documentation</h2>
<a class="anchor" name="dff12b8ac65a0bdaf2d6be82b21f1b93"></a><!-- doxytag: member="CNetworkRegInfo::~CNetworkRegInfo" ref="dff12b8ac65a0bdaf2d6be82b21f1b93" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CNetworkRegInfo::~CNetworkRegInfo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor. Calls Cancel() to cancel outstanding requests.<p>
Destructor. Cancels outstanding requests.<p>
Destructor.
<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><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c48f97258f5d06a459de3fc2af2c4bb4"></a><!-- doxytag: member="CNetworkRegInfo::NewL" ref="c48f97258f5d06a459de3fc2af2c4bb4" 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> * </td>
<td class="paramname"> <em>aController</em> </td>
<td> ) </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> </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_network_reg_info.html">CNetworkRegInfo</a> class</dd></dl>
Factory constructor. <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> </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_network_reg_info.html">CNetworkRegInfo</a> class</dd></dl>
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> </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_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><p>
<a class="anchor" name="69f884ecb621fc58a85c786b8d627ba0"></a><!-- doxytag: member="CNetworkRegInfo::DoStartRequestL" ref="69f884ecb621fc58a85c786b8d627ba0" 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> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Kicks off request.<p>
Gets the network registration status and stores it in the iNetworkRegV1Pckg 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="_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><p>
<a class="anchor" name="a058fa58ea14c54734c93e1531698d8c"></a><!-- doxytag: member="CNetworkRegInfo::DoRequestNotificationL" ref="a058fa58ea14c54734c93e1531698d8c" 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> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Requests to receive notifications of change in the network registration information.<p>
Requests to receive notifications of changes in the network registration status.
<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="_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><p>
<a class="anchor" name="699e05733410059346224352f34134f6"></a><!-- doxytag: member="CNetworkRegInfo::StartRequestL" ref="699e05733410059346224352f34134f6" 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> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the network registration status and stores it in the iNetworkRegV1Pckg package.
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#e582ca026eb25869ea1e130fe16d2e79">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><p>
<a class="anchor" name="19c26e7c01ab757451b427a1f2d76c26"></a><!-- doxytag: member="CNetworkRegInfo::RequestNotificationL" ref="19c26e7c01ab757451b427a1f2d76c26" 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> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Requests to receive notifications of changes in the network registration status.
<p>Reimplemented from <a class="el" href="class_c_i_s_v_a_p_i_base.html#b6f0b35112b18c2058f88ab35a9a68c7">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><p>
<a class="anchor" name="69f884ecb621fc58a85c786b8d627ba0"></a><!-- doxytag: member="CNetworkRegInfo::DoStartRequestL" ref="69f884ecb621fc58a85c786b8d627ba0" 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> ) </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="a058fa58ea14c54734c93e1531698d8c"></a><!-- doxytag: member="CNetworkRegInfo::DoRequestNotificationL" ref="a058fa58ea14c54734c93e1531698d8c" 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> ) </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="a85225589261df96e8caf34b34054584"></a><!-- doxytag: member="CNetworkRegInfo::iNetworkRegV1" ref="a85225589261df96e8caf34b34054584" 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#a85225589261df96e8caf34b34054584">CNetworkRegInfo::iNetworkRegV1</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stores the network registration status retrieved.<p>
Stores the retrieved network registration information.<p>
Stores retrieved network registration information.
<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><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by
<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>