<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Irrlicht Engine: irr::io::IFileArchive Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
<tr valign="middle">
<td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a>
| <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a>
| <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a>
| <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical
List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF">
Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a>
| <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF">
Namespace Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class
members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File
members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
</tr>
</table>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1io.html">io</a>::<a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a>
</div>
<div class="contents">
<h1>irr::io::IFileArchive Class Reference</h1><!-- doxytag: class="irr::io::IFileArchive" --><!-- doxytag: inherits="irr::IReferenceCounted" -->The FileArchive manages archives and provides access to files inside them.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="_i_file_archive_8h-source.html">IFileArchive.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for irr::io::IFileArchive:</div>
<div class="dynsection">
<p><center><img src="classirr_1_1io_1_1_i_file_archive.png" usemap="#irr::io::IFileArchive_map" border="0" alt=""></center>
<map name="irr::io::IFileArchive_map">
<area href="classirr_1_1_i_reference_counted.html" alt="irr::IReferenceCounted" shape="rect" coords="0,0,140,24">
</map>
</div>
<p>
<a href="classirr_1_1io_1_1_i_file_archive-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">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html#b6bc8fbd660bbbe42b4d30a9d4f26c7d">createAndOpenFile</a> (<a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> index)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens a file based on its position in the file list. <a href="#b6bc8fbd660bbbe42b4d30a9d4f26c7d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html#5c3b4994ae63447d2634dd86b3069988">createAndOpenFile</a> (const <a class="el" href="classirr_1_1core_1_1string.html">path</a> &filename)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens a file based on its name. <a href="#5c3b4994ae63447d2634dd86b3069988"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html#73c683318837b13d16843373da00ded3">getFileList</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the complete file tree. <a href="#73c683318837b13d16843373da00ded3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr_1_1io.html#db3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html#cffb15450606924696fb8f9608819536">getType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the archive type <a href="#cffb15450606924696fb8f9608819536"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The FileArchive manages archives and provides access to files inside them.
<p>Definition at line <a class="el" href="_i_file_archive_8h-source.html#l00047">47</a> of file <a class="el" href="_i_file_archive_8h-source.html">IFileArchive.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b6bc8fbd660bbbe42b4d30a9d4f26c7d"></a><!-- doxytag: member="irr::io::IFileArchive::createAndOpenFile" ref="b6bc8fbd660bbbe42b4d30a9d4f26c7d" args="(u32 index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a>* irr::io::IFileArchive::createAndOpenFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opens a file based on its position in the file list.
<p>
Creates and returns <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The zero based index of the file. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns a pointer to the created file on success, or 0 on failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5c3b4994ae63447d2634dd86b3069988"></a><!-- doxytag: member="irr::io::IFileArchive::createAndOpenFile" ref="5c3b4994ae63447d2634dd86b3069988" args="(const path &filename)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a>* irr::io::IFileArchive::createAndOpenFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classirr_1_1core_1_1string.html">path</a> & </td>
<td class="paramname"> <em>filename</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opens a file based on its name.
<p>
Creates and returns a new <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> for a file in the archive. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The file to open </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns A pointer to the created file on success, or 0 on failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="73c683318837b13d16843373da00ded3"></a><!-- doxytag: member="irr::io::IFileArchive::getFileList" ref="73c683318837b13d16843373da00ded3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a>* irr::io::IFileArchive::getFileList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the complete file tree.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the complete directory tree for the archive, including all files and folders </dd></dl>
</div>
</div><p>
<a class="anchor" name="cffb15450606924696fb8f9608819536"></a><!-- doxytag: member="irr::io::IFileArchive::getType" ref="cffb15450606924696fb8f9608819536" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#db3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> irr::io::IFileArchive::getType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the archive type
<p>
<p>Definition at line <a class="el" href="_i_file_archive_8h-source.html#l00070">70</a> of file <a class="el" href="_i_file_archive_8h-source.html">IFileArchive.h</a>.</p>
<p>References <a class="el" href="_i_file_archive_8h-source.html#l00043">irr::io::EFAT_UNKNOWN</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_file_archive_8h-source.html">IFileArchive.h</a></ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
<tr>
<td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
<td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2009 by Nikolaus Gebhardt. Generated
on Sun Jan 10 09:24:12 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a>
(1.5.6)</font></em></small></div></td>
</tr>
</table>
<address style="align: right;">
</address>
</body>
</html>
