Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_ezlib_example.html
Initial contribution of the Adaptation Documentation.
<!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: CEzlibExample 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>CEzlibExample Class Reference</h1><!-- doxytag: class="CEzlibExample" -->
<p><a href="class_c_ezlib_example-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#a48c59ffbda5ce37120fa9d017830d57c">~CEzlibExample</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0df2c876084c106f63ac7adaac4007c1"></a><!-- doxytag: member="CEzlibExample::OpenZipFileL" ref="a0df2c876084c106f63ac7adaac4007c1" args="(RFs &aFsSession)" -->
void </td><td class="memItemRight" valign="bottom"><b>OpenZipFileL</b> (RFs &aFsSession)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#af8c5bb49dba35b4870f4849ec1a70151">GetPropertiesL</a> (TFileName &aFileName, RFs &aFsSession)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#a5e98fd4d876b8bada261be2de5cd755d">ExtractFilesL</a> (const CZipFileMember *aMember, CZipFile *aZipFile, RFs &aFsSession, const TDesC &aOutputPath)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#a462f99cf9b1dd1ebdc0fbc279cc7d229">CompressToGzipFileL</a> (RFs &aFsSession)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_ezlib_example.html#a81f560db578514ae40d41a6946ad7e6b">ExtractGzipFileL</a> (RFs &aFsSession)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" 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#a7c541c9d16531ccc9ca4876cc9bfa33f">NewLC</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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>
<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" id="a48c59ffbda5ce37120fa9d017830d57c"></a><!-- doxytag: member="CEzlibExample::~CEzlibExample" ref="a48c59ffbda5ce37120fa9d017830d57c" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7c541c9d16531ccc9ca4876cc9bfa33f"></a><!-- doxytag: member="CEzlibExample::NewLC" ref="a7c541c9d16531ccc9ca4876cc9bfa33f" 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><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>
<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>
<a class="anchor" id="af8c5bb49dba35b4870f4849ec1a70151"></a><!-- doxytag: member="CEzlibExample::GetPropertiesL" ref="af8c5bb49dba35b4870f4849ec1a70151" 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></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><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>
</dd>
</dl>
<p>KZipArchiveError KZipFileIOError KCentralDirectoryTrailerNotFound KCentralDirectoryTrailerInvalid KMultiDiskArchivesNotSupported ... A system-wide error code. </p>
<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>
<a class="anchor" id="a5e98fd4d876b8bada261be2de5cd755d"></a><!-- doxytag: member="CEzlibExample::ExtractFilesL" ref="a5e98fd4d876b8bada261be2de5cd755d" 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></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><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>
</dd>
</dl>
<p>... A system-wide error code. </p>
<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>
<a class="anchor" id="a462f99cf9b1dd1ebdc0fbc279cc7d229"></a><!-- doxytag: member="CEzlibExample::CompressToGzipFileL" ref="a462f99cf9b1dd1ebdc0fbc279cc7d229" 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></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><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>
</dd>
</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>
<a class="anchor" id="a81f560db578514ae40d41a6946ad7e6b"></a><!-- doxytag: member="CEzlibExample::ExtractGzipFileL" ref="a81f560db578514ae40d41a6946ad7e6b" 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></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><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>
</dd>
</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>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>