Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_send_as2_example.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: CSendAs2Example 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>CSendAs2Example Class Reference</h1><!-- doxytag: class="CSendAs2Example" -->
<p>
<a href="class_c_send_as2_example-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_send_as2_example.html#62977f8fc97dc3ff5f271046ce8e93b6">~CSendAs2Example</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_send_as2_example.html#7ccdc243eaf209d64a5e1850f4d6ed26">StartL</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_send_as2_example.html#b6d9f868e9f8e742ca0c935bd08c855d">Connect</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_send_as2_example.html#762ac16c692ec849b8e60639d026645e">CreateL</a> (RSendAsMessage &amp;aMessage)</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_send_as2_example.html#1621f9de94164edff4d459d06cb82f44">DisplayAccountL</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_send_as2_example.html#40f320dceace4d1ff163a3944d8755fb">CapabilityFilterL</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_send_as2_example.html#d91005c90f3863a181b7a54dc8f0c969">SendL</a> (RSendAsMessage &amp;aMessage)</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_send_as2_example.html">CSendAs2Example</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_send_as2_example.html#2e08d46acb9714ab572ce1aff21f3d71">NewL</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="class_c_send_as2_example.html">CSendAs2Example</a> is a class that publicly inherits from CBase. CBase is the base class for all classes to be instantiated on the heap. This class demonstrates- creating a session, connecting to sendAs server to create a message, displaying the list of SendAs accounts present, Filtering those messages based on capability and sending the message. 
<p>Definition at line <a class="el" href="_send_as2_example_8h-source.html#l00038">38</a> of file <a class="el" href="_send_as2_example_8h-source.html">SendAs2Example.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="62977f8fc97dc3ff5f271046ce8e93b6"></a><!-- doxytag: member="CSendAs2Example::~CSendAs2Example" ref="62977f8fc97dc3ff5f271046ce8e93b6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CSendAs2Example::~CSendAs2Example           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Cleans the application<ul>
<li>closes the sendAs server</li><li>deletes the console window</li><li>deletes all other member variables </li></ul>

<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00085">85</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2e08d46acb9714ab572ce1aff21f3d71"></a><!-- doxytag: member="CSendAs2Example::NewL" ref="2e08d46acb9714ab572ce1aff21f3d71" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_send_as2_example.html">CSendAs2Example</a> * CSendAs2Example::NewL           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allocates and constructs a <a class="el" href="class_c_send_as2_example.html">CSendAs2Example</a> object. Initialises all member data to their default values. 
<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00051">51</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="7ccdc243eaf209d64a5e1850f4d6ed26"></a><!-- doxytag: member="CSendAs2Example::StartL" ref="7ccdc243eaf209d64a5e1850f4d6ed26" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSendAs2Example::StartL           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Main function which calls other functions. Creates a session observer and sets the entry on drafts folder. Also, gets a selection containing the IDs of all the context children.  KErrNoMemory, system wide error codes 
<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00109">109</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="b6d9f868e9f8e742ca0c935bd08c855d"></a><!-- doxytag: member="CSendAs2Example::Connect" ref="b6d9f868e9f8e742ca0c935bd08c855d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSendAs2Example::Connect           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a session<ul>
<li>based on the time slots</li><li>connects to the server  system wide error codes </li></ul>

<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00135">135</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="762ac16c692ec849b8e60639d026645e"></a><!-- doxytag: member="CSendAs2Example::CreateL" ref="762ac16c692ec849b8e60639d026645e" args="(RSendAsMessage &amp;aMessage)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSendAs2Example::CreateL           </td>
          <td>(</td>
          <td class="paramtype">RSendAsMessage &amp;&nbsp;</td>
          <td class="paramname"> <em>aMessage</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a SendAs message <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aMessage</em>&nbsp;</td><td>An RSendAsMessage reference, used to create a message </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00165">165</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="1621f9de94164edff4d459d06cb82f44"></a><!-- doxytag: member="CSendAs2Example::DisplayAccountL" ref="1621f9de94164edff4d459d06cb82f44" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSendAs2Example::DisplayAccountL           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Displays the names of all the available accounts. Creates accounts, if not already created. 
<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00215">215</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="40f320dceace4d1ff163a3944d8755fb"></a><!-- doxytag: member="CSendAs2Example::CapabilityFilterL" ref="40f320dceace4d1ff163a3944d8755fb" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSendAs2Example::CapabilityFilterL           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Refines the connected session's available message types. Applying a filter will remove all mtms which do not support the supplied capability  system wide error codes 
<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00255">255</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="d91005c90f3863a181b7a54dc8f0c969"></a><!-- doxytag: member="CSendAs2Example::SendL" ref="d91005c90f3863a181b7a54dc8f0c969" args="(RSendAsMessage &amp;aMessage)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CSendAs2Example::SendL           </td>
          <td>(</td>
          <td class="paramtype">RSendAsMessage &amp;&nbsp;</td>
          <td class="paramname"> <em>aMessage</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sends the sendAs2 message <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aMessage</em>&nbsp;</td><td>An RSendAsMessage reference, used to send a message </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="_send_as2_example_8cpp-source.html#l00273">273</a> of file <a class="el" href="_send_as2_example_8cpp-source.html">SendAs2Example.cpp</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&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>