Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_ezlib_example.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_ezlib_example.html Fri Jan 22 18:26:19 2010 +0000
@@ -0,0 +1,227 @@
+<!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: CEzlibExample 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>CEzlibExample Class Reference</h1><!-- doxytag: class="CEzlibExample" -->
+<p>
+<a href="class_c_ezlib_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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#48c59ffbda5ce37120fa9d017830d57c">~CEzlibExample</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0df2c876084c106f63ac7adaac4007c1"></a><!-- doxytag: member="CEzlibExample::OpenZipFileL" ref="0df2c876084c106f63ac7adaac4007c1" args="(RFs &aFsSession)" -->
+void </td><td class="memItemRight" valign="bottom"><b>OpenZipFileL</b> (RFs &aFsSession)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#f8c5bb49dba35b4870f4849ec1a70151">GetPropertiesL</a> (TFileName &aFileName, RFs &aFsSession)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#5e98fd4d876b8bada261be2de5cd755d">ExtractFilesL</a> (const CZipFileMember *aMember, CZipFile *aZipFile, RFs &aFsSession, const TDesC &aOutputPath)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#462f99cf9b1dd1ebdc0fbc279cc7d229">CompressToGzipFileL</a> (RFs &aFsSession)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#81f560db578514ae40d41a6946ad7e6b">ExtractGzipFileL</a> (RFs &aFsSession)</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_ezlib_example.html">CEzlibExample</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#7c541c9d16531ccc9ca4876cc9bfa33f">NewLC</a> ()</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Demonstrates the use of the Symbian platform Ezlib component to zip and unzip .GZ files and unzip .ZIP files. <a class="el" href="class_c_ezlib_example.html">CEzlibExample</a> publicly inherits from CBase, which is the base class for all classes to be instantiated on the heap.
+<p>Definition at line <a class="el" href="ezlibexample_8h-source.html#l00033">33</a> of file <a class="el" href="ezlibexample_8h-source.html">ezlibexample.h</a>.</p>
+<hr><h2>Constructor & Destructor Documentation</h2>
+<a class="anchor" name="48c59ffbda5ce37120fa9d017830d57c"></a><!-- doxytag: member="CEzlibExample::~CEzlibExample" ref="48c59ffbda5ce37120fa9d017830d57c" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">CEzlibExample::~CEzlibExample </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td> ) </td>
+ <td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Destructor
+<p>Definition at line <a class="el" href="ezlibexample_8cpp-source.html#l00100">100</a> of file <a class="el" href="ezlibexample_8cpp-source.html">ezlibexample.cpp</a>.</p>
+
+</div>
+</div><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="7c541c9d16531ccc9ca4876cc9bfa33f"></a><!-- doxytag: member="CEzlibExample::NewLC" ref="7c541c9d16531ccc9ca4876cc9bfa33f" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="class_c_ezlib_example.html">CEzlibExample</a> * CEzlibExample::NewLC </td>
+ <td>(</td>
+ <td class="paramname"> </td>
+ <td> ) </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_ezlib_example.html">CEzlibExample</a> object and leaves it on the cleanup stack. Initialises all member data to their default values.
+<p>Definition at line <a class="el" href="ezlibexample_8cpp-source.html#l00075">75</a> of file <a class="el" href="ezlibexample_8cpp-source.html">ezlibexample.cpp</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="f8c5bb49dba35b4870f4849ec1a70151"></a><!-- doxytag: member="CEzlibExample::GetPropertiesL" ref="f8c5bb49dba35b4870f4849ec1a70151" args="(TFileName &aFileName, RFs &aFsSession)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void CEzlibExample::GetPropertiesL </td>
+ <td>(</td>
+ <td class="paramtype">TFileName & </td>
+ <td class="paramname"> <em>aFileName</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">RFs & </td>
+ <td class="paramname"> <em>aFsSession</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Gets the properties of each member of the zip file passed to it and prints it on the console.<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>aFileName</em> </td><td>Pointer to a file whose properties are to be fetched. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aFsSession</em> </td><td>File server session handle</td></tr>
+ </table>
+</dl>
+KZipArchiveError KZipFileIOError KCentralDirectoryTrailerNotFound KCentralDirectoryTrailerInvalid KMultiDiskArchivesNotSupported ... A system-wide error code.
+<p>Definition at line <a class="el" href="ezlibexample_8cpp-source.html#l00123">123</a> of file <a class="el" href="ezlibexample_8cpp-source.html">ezlibexample.cpp</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="5e98fd4d876b8bada261be2de5cd755d"></a><!-- doxytag: member="CEzlibExample::ExtractFilesL" ref="5e98fd4d876b8bada261be2de5cd755d" args="(const CZipFileMember *aMember, CZipFile *aZipFile, RFs &aFsSession, const TDesC &aOutputPath)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void CEzlibExample::ExtractFilesL </td>
+ <td>(</td>
+ <td class="paramtype">const CZipFileMember * </td>
+ <td class="paramname"> <em>aMember</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">CZipFile * </td>
+ <td class="paramname"> <em>aZipFile</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">RFs & </td>
+ <td class="paramname"> <em>aFsSession</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const TDesC & </td>
+ <td class="paramname"> <em>aOutputPath</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Extracts and saves the members of a zip file to the directory passed to the function as aOutputPath.<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>aMember</em> </td><td>Pointer to CZipFileMember class </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aZipFile</em> </td><td>Pointer to CZipFile class </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aFsSession</em> </td><td>File server session handle </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aOutputPath</em> </td><td>Path where the file needs to be extracted to</td></tr>
+ </table>
+</dl>
+... A system-wide error code.
+<p>Definition at line <a class="el" href="ezlibexample_8cpp-source.html#l00218">218</a> of file <a class="el" href="ezlibexample_8cpp-source.html">ezlibexample.cpp</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="462f99cf9b1dd1ebdc0fbc279cc7d229"></a><!-- doxytag: member="CEzlibExample::CompressToGzipFileL" ref="462f99cf9b1dd1ebdc0fbc279cc7d229" args="(RFs &aFsSession)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void CEzlibExample::CompressToGzipFileL </td>
+ <td>(</td>
+ <td class="paramtype">RFs & </td>
+ <td class="paramname"> <em>aFsSession</em> </td>
+ <td> ) </td>
+ <td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Compresses the error.wav file into a gzip file and stores it in the c:\private\e80000b7\gzip\extracts directory.<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>aFsSession</em> </td><td>File server session handle KErrAlreadyExists ... A system-wide error code. </td></tr>
+ </table>
+</dl>
+
+<p>Definition at line <a class="el" href="ezlibexample_8cpp-source.html#l00353">353</a> of file <a class="el" href="ezlibexample_8cpp-source.html">ezlibexample.cpp</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="81f560db578514ae40d41a6946ad7e6b"></a><!-- doxytag: member="CEzlibExample::ExtractGzipFileL" ref="81f560db578514ae40d41a6946ad7e6b" args="(RFs &aFsSession)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void CEzlibExample::ExtractGzipFileL </td>
+ <td>(</td>
+ <td class="paramtype">RFs & </td>
+ <td class="paramname"> <em>aFsSession</em> </td>
+ <td> ) </td>
+ <td width="100%"></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>
+Opens the icon.bmp.gz file and decompresses it to the c:\private\e80000b7\gzip\extracts directory.<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>aFsSession</em> </td><td>File server session handle KErrAlreadyExists ... A system-wide error code. </td></tr>
+ </table>
+</dl>
+
+<p>Definition at line <a class="el" href="ezlibexample_8cpp-source.html#l00285">285</a> of file <a class="el" href="ezlibexample_8cpp-source.html">ezlibexample.cpp</a>.</p>
+
+</div>
+</div><p>
+<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:05 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>