Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_write_to_file_8cpp_source.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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     2
<html xmlns="http://www.w3.org/1999/xhtml">
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     3
<head>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     5
<title>TB9.2 Example Applications: examples/Base/BufsAndStrings/WriteToFiles/WriteToFile.cpp Source File</title>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     8
</head>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
     9
<body>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    10
<!-- Generated by Doxygen 1.6.2 -->
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    11
<h1>examples/Base/BufsAndStrings/WriteToFiles/WriteToFile.cpp</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>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    12
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    13
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    14
<a name="l00004"></a>00004 <span class="comment">// under the terms of &quot;Eclipse Public License v1.0&quot;</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    15
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    16
<a name="l00006"></a>00006 <span class="comment">// at the URL &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    17
<a name="l00007"></a>00007 <span class="comment">//</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    18
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    19
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    20
<a name="l00010"></a>00010 <span class="comment">//</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    21
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    22
<a name="l00012"></a>00012 <span class="comment">//</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    23
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    24
<a name="l00014"></a>00014 <span class="comment">// This example writes the text &quot;hello world!&quot; to a file</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    25
<a name="l00015"></a>00015 <span class="comment">// Use it as the basis of all examples which depend on just E32 and F32</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    26
<a name="l00016"></a>00016 <span class="comment">//</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    27
<a name="l00017"></a>00017 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    28
<a name="l00018"></a>00018 <span class="preprocessor">#include &quot;CommonFramework.h&quot;</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    29
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;f32file.h&gt;</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    30
<a name="l00020"></a>00020 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    31
<a name="l00021"></a>00021 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KFileName,<span class="stringliteral">&quot;WriteToFile.dat&quot;</span>);
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    32
<a name="l00022"></a>00022 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KGreetingText,<span class="stringliteral">&quot;Hello World!\n&quot;</span>);
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    33
<a name="l00023"></a>00023 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    34
<a name="l00024"></a>00024 <span class="comment">// Do the example</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    35
<a name="l00025"></a>00025 <span class="keyword">static</span> <span class="keywordtype">void</span> doExampleL()
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    36
<a name="l00026"></a>00026     {
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    37
<a name="l00027"></a>00027                                              <span class="comment">// The file server session.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    38
<a name="l00028"></a>00028         RFs fsSession;                           
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    39
<a name="l00029"></a>00029                                                  <span class="comment">// Connect to the file server session.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    40
<a name="l00030"></a>00030         User::LeaveIfError(fsSession.Connect()); 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    41
<a name="l00031"></a>00031         
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    42
<a name="l00032"></a>00032                                                  <span class="comment">// create the private directory</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    43
<a name="l00033"></a>00033                                                  <span class="comment">// on the writable drive</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    44
<a name="l00034"></a>00034                                                  <span class="comment">// i.e. &quot;\private\0FFFFF00\&quot;</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    45
<a name="l00035"></a>00035                                                  <span class="comment">// Note that the number 0FFFFF00 is the </span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    46
<a name="l00036"></a>00036                                                  <span class="comment">// process security id taken from the 2nd UID</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    47
<a name="l00037"></a>00037                                                  <span class="comment">// specified in the mmp file.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    48
<a name="l00038"></a>00038 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    49
<a name="l00039"></a>00039     fsSession.CreatePrivatePath(RFs::GetSystemDrive());
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    50
<a name="l00040"></a>00040                                              <span class="comment">// Set the session path to</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    51
<a name="l00041"></a>00041                                              <span class="comment">// this private directory on the writable drive</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    52
<a name="l00042"></a>00042     fsSession.SetSessionToPrivate(RFs::GetSystemDrive());
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    53
<a name="l00043"></a>00043                                                  
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    54
<a name="l00044"></a>00044                                              <span class="comment">// Use this object to represent</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    55
<a name="l00045"></a>00045                                              <span class="comment">// the file to be written to.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    56
<a name="l00046"></a>00046         RFile file;                                  
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    57
<a name="l00047"></a>00047                                                      
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    58
<a name="l00048"></a>00048         User::LeaveIfError(file.Replace(fsSession,KFileName,EFileWrite|EFileStreamText));
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    59
<a name="l00049"></a>00049 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    60
<a name="l00050"></a>00050                 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    61
<a name="l00051"></a>00051                                                      <span class="comment">// Note that Write() requires a TDesC8</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    62
<a name="l00052"></a>00052                                                      <span class="comment">// type so we need to construct an explicit</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    63
<a name="l00053"></a>00053                                                      <span class="comment">// TDesC8 type to represent the data contained</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    64
<a name="l00054"></a>00054                                                      <span class="comment">// in the standard (16-bit) descriptor.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    65
<a name="l00055"></a>00055         TPtrC8 representation((TUint8*)(&amp;KGreetingText)-&gt;Ptr(), (&amp;KGreetingText)-&gt;Size());
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    66
<a name="l00056"></a>00056         
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    67
<a name="l00057"></a>00057                                                  <span class="comment">// Write the text ...</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    68
<a name="l00058"></a>00058         User::LeaveIfError(file.Write(representation));
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    69
<a name="l00059"></a>00059                                                      
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    70
<a name="l00060"></a>00060                                                  <span class="comment">// ... and commit the text.</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    71
<a name="l00061"></a>00061         User::LeaveIfError(file.Flush());
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    72
<a name="l00062"></a>00062         
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    73
<a name="l00063"></a>00063         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt1,<span class="stringliteral">&quot;Data written to file\n&quot;</span>);
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    74
<a name="l00064"></a>00064         console-&gt;Printf(KTxt1);
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    75
<a name="l00065"></a>00065                                                      <span class="comment">// Close file</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    76
<a name="l00066"></a>00066         file.Close(); 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    77
<a name="l00067"></a>00067                                                      <span class="comment">// Delete file (remove comment if you want</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    78
<a name="l00068"></a>00068                                                      <span class="comment">// to do this)</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    79
<a name="l00069"></a>00069         <span class="comment">//User::LeaveIfError(fsSession.Delete(KFileName));</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    80
<a name="l00070"></a>00070         
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    81
<a name="l00071"></a>00071                                                          <span class="comment">// close file server session</span>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    82
<a name="l00072"></a>00072         fsSession.Close(); 
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    83
<a name="l00073"></a>00073         }
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    84
</pre></div></div>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    85
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    86
<a href="http://www.doxygen.org/index.html">
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    87
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    88
</body>
43e37759235e Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    89
</html>