Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_file_forwarder.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: CFileForwarder 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>CFileForwarder Class Reference</h1><!-- doxytag: class="CFileForwarder" --><!-- doxytag: inherits="MResultViewer" -->
<p>Inherits <a class="el" href="class_m_result_viewer.html">MResultViewer</a>.</p>

<p><a href="class_c_file_forwarder-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_file_forwarder.html#a8ba86f9e2f054d9c44114276428cfe98">ConstructL</a> (const TDesC &amp;logFileName=KDefaultLogFile)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual TPtr&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_file_forwarder.html#a6e4641a03eaf706f957e7ed7014bcec3">GetViewBuffer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_file_forwarder.html#abcff5e4b92b098ffd0474ce712493d49">UpdateView</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="_descriptor_examples_8h_source.html#l00206">206</a> of file <a class="el" href="_descriptor_examples_8h_source.html">DescriptorExamples.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8ba86f9e2f054d9c44114276428cfe98"></a><!-- doxytag: member="CFileForwarder::ConstructL" ref="a8ba86f9e2f054d9c44114276428cfe98" args="(const TDesC &amp;logFileName=KDefaultLogFile)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFileForwarder::ConstructL </td>
          <td>(</td>
          <td class="paramtype">const TDesC &amp;&nbsp;</td>
          <td class="paramname"> <em>logFileName</em> = <code>KDefaultLogFile</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Construct an instance of the <a class="el" href="class_m_result_viewer.html">MResultViewer</a> that writes contents to the file specified by logFileName parameter. The file is opened at the construction time and kept open until object is destroyed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>logFileName</em>&nbsp;</td><td>file name where contents are written. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_file_forwarder_8cpp_source.html#l00014">14</a> of file <a class="el" href="_file_forwarder_8cpp_source.html">FileForwarder.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6e4641a03eaf706f957e7ed7014bcec3"></a><!-- doxytag: member="CFileForwarder::GetViewBuffer" ref="a6e4641a03eaf706f957e7ed7014bcec3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TPtr CFileForwarder::GetViewBuffer </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a modifiable descriptor to the internal buffer. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_m_result_viewer.html#a30d7e86bbb78ba769648736a9ee9e62d">MResultViewer::GetViewBuffer()</a>. </dd></dl>

<p>Implements <a class="el" href="class_m_result_viewer.html#a30d7e86bbb78ba769648736a9ee9e62d">MResultViewer</a>.</p>

<p>Definition at line <a class="el" href="_file_forwarder_8cpp_source.html#l00041">41</a> of file <a class="el" href="_file_forwarder_8cpp_source.html">FileForwarder.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abcff5e4b92b098ffd0474ce712493d49"></a><!-- doxytag: member="CFileForwarder::UpdateView" ref="abcff5e4b92b098ffd0474ce712493d49" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CFileForwarder::UpdateView </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Flushes the text to the file and resets the internal buffer. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_m_result_viewer.html#a8e10673e2504a4af6382f26794bb8004">MResultViewer::UpdateView()</a>. </dd></dl>

<p>Implements <a class="el" href="class_m_result_viewer.html#a8e10673e2504a4af6382f26794bb8004">MResultViewer</a>.</p>

<p>Definition at line <a class="el" href="_file_forwarder_8cpp_source.html#l00049">49</a> of file <a class="el" href="_file_forwarder_8cpp_source.html">FileForwarder.cpp</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>