Mercurial Mercurial > oss > FCL > sftools > depl > docscontent / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_common_files_8h-source.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Thu, 11 Mar 2010 15:24:26 +0000
changeset 2 ebc84c812384
parent 1 25a17d01db0c
permissions -rw-r--r--
week 10 bug fix submission: Bug 1892, Bug 1897, Bug 1319. Also 3 or 4 documents were found to contain code blocks with SFL, which has been fixed. Partial fix for broken links, links to Forum Nokia, and the 'Symbian platform' terminology issues.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     3
 
<title>TB10.1 Example Applications: examples/SerialComms/ServerClientSide/CommonFiles/CommonFiles.h Source File</title>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     4
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     5
 
<link href="tabs.css" rel="stylesheet" type="text/css">
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     6
 
</head><body>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     7
 
<!-- Generated by Doxygen 1.5.3 -->
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     8
 
<h1>examples/SerialComms/ServerClientSide/CommonFiles/CommonFiles.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
     9
 
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    10
 
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    11
 
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    12
 
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    13
 
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    14
 
<a name="l00007"></a>00007 <span class="comment">//</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    15
 
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    16
 
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    17
 
<a name="l00010"></a>00010 <span class="comment">//</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    18
 
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    19
 
<a name="l00012"></a>00012 <span class="comment">//</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    20
 
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    21
 
<a name="l00014"></a>00014 <span class="comment">//</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    22
 
<a name="l00015"></a>00015
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    23
 
<a name="l00016"></a>00016
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    24
 
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __CommonFiles_H</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    25
 
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __CommonFiles_H</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    26
 
<a name="l00019"></a>00019 <span class="preprocessor"></span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    27
 
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;e32cons.h&gt;</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    28
 
<a name="l00021"></a>00021
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    29
 
<a name="l00022"></a>00022 <span class="comment">// public</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    30
 
<a name="l00023"></a>00023 LOCAL_D CConsoleBase* <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>; <span class="comment">// write all your messages to this</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    31
 
<a name="l00024"></a>00024 LOCAL_C <span class="keywordtype">void</span> doExampleL(); <span class="comment">// code this function for the real example</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    32
 
<a name="l00025"></a>00025
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    33
 
<a name="l00026"></a>00026 <span class="comment">// private</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    34
 
<a name="l00027"></a>00027 LOCAL_C <span class="keywordtype">void</span> callExampleL(); <span class="comment">// initialize with cleanup stack, then do example</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    35
 
<a name="l00028"></a>00028
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    36
 
<a name="l00029"></a>00029 GLDEF_C TInt <a class="code" href="dbllist_8cpp.html#0f358e9c4355138f629b8c4f37310295">E32Main</a>() <span class="comment">// main function called by E32</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    37
 
<a name="l00030"></a>00030     {
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    38
 
<a name="l00031"></a>00031         _LIT(KSymbianEx,<span class="stringliteral">"SymbianEx"</span>);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    39
 
<a name="l00032"></a>00032         CTrapCleanup* cleanup=CTrapCleanup::New(); <span class="comment">// get clean-up stack</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    40
 
<a name="l00033"></a>00033         TRAPD(<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>,callExampleL()); <span class="comment">// more initialization, then do example</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    41
 
<a name="l00034"></a>00034         __ASSERT_ALWAYS(!<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>,User::Panic(KSymbianEx,<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>));
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    42
 
<a name="l00035"></a>00035         <span class="keyword">delete</span> cleanup; <span class="comment">// destroy clean-up stack</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    43
 
<a name="l00036"></a>00036         <span class="keywordflow">return</span> 0; <span class="comment">// and return</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    44
 
<a name="l00037"></a>00037     }
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    45
 
<a name="l00038"></a>00038
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    46
 
<a name="l00039"></a>00039 LOCAL_C <span class="keywordtype">void</span> callExampleL() <span class="comment">// initialize and call example code under cleanup stack</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    47
 
<a name="l00040"></a>00040     {
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    48
 
<a name="l00041"></a>00041         _LIT(KStatus1,<span class="stringliteral">"Symbian platform Example Code (comms)"</span>);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    49
 
<a name="l00042"></a>00042         _LIT(KStatus2,<span class="stringliteral">"failed: leave code=%d"</span>);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    50
 
<a name="l00043"></a>00043         _LIT(KStatus3,<span class="stringliteral">"ok"</span>);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    51
 
<a name="l00044"></a>00044         _LIT(KStatus4,<span class="stringliteral">" [press any key]"</span>);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    52
 
<a name="l00045"></a>00045
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    53
 
<a name="l00046"></a>00046         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>=Console::NewL(KStatus1,TSize(KConsFullScreen,KConsFullScreen));
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    54
 
<a name="l00047"></a>00047         <span class="comment">//console=Console::NewL(KStatus1, TSize(KDefaultConsWidth,KDefaultConsHeight));</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    55
 
<a name="l00048"></a>00048         CleanupStack::PushL(<a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    56
 
<a name="l00049"></a>00049         TRAPD(<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>,doExampleL()); <span class="comment">// perform example function</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    57
 
<a name="l00050"></a>00050         <span class="keywordflow">if</span> (<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>) <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KStatus2, <a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    58
 
<a name="l00051"></a>00051         <span class="keywordflow">else</span> <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KStatus3);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    59
 
<a name="l00052"></a>00052         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KStatus4);
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    60
 
<a name="l00053"></a>00053         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Getch(); <span class="comment">// get and ignore character</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    61
 
<a name="l00054"></a>00054         CleanupStack::Pop(); <span class="comment">// close console</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    62
 
<a name="l00055"></a>00055     }
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    63
 
<a name="l00056"></a>00056
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    64
 
<a name="l00057"></a>00057 <span class="preprocessor">#endif</span>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    65
 
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:00 2010 for TB10.1 Example Applications by&nbsp;
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    66
 
<a href="http://www.doxygen.org/index.html">
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    67
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    68
 
</body>
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset 
    69
 
</html>
FCL/sftools/depl/docscontent