<!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>FileReader class Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="inspircd.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc3 -->
<center>
-<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
+<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>FileReader Class Reference</h1>Caches a text file into memory and can be used to retrieve lines from it.
<a href="#_details">More...</a>
<p>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classFileReader.html#a3">LoadFile</a> (std::string filename)</td></tr>
<tr><td> </td><td><font size=-1><em>Used to load a file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classFileReader.html#a4">Exists</a> ()</td></tr>
-<tr><td> </td><td><font size=-1><em>Retrieve one line from the file.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
+<tr><td> </td><td><font size=-1><em>Returns true if the file exists This function will return false if the file could not be opened.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classFileReader.html#a5">GetLine</a> (int x)</td></tr>
+<tr><td> </td><td><font size=-1><em>Retrieve one line from the file.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classFileReader.html#a6">FileSize</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the size of the file in lines.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top><a class="el" href="modules_8h.html#a9">file_cache</a> </td><td valign=bottom><a class="el" href="classFileReader.html#o0">fc</a></td></tr>
+<tr><td nowrap align=right valign=top><a class="el" href="modules_8h.html#a10">file_cache</a> </td><td valign=bottom><a class="el" href="classFileReader.html#o0">fc</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Caches a text file into memory and can be used to retrieve lines from it.
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00367">367</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
+Definition at line <a class="el" href="modules_8h-source.html#l00529">529</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="FileReader::FileReader"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<p>
This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00269">269</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00370">370</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00270 {
-00271 }
+<div class="fragment"><pre>00371 {
+00372 }
</pre></div> </td>
</tr>
</table>
<p>
This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00262">262</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00363">363</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00369">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00531">fc</a>, and <a class="el" href="modules_8h-source.html#l00030">file_cache</a>.
<p>
-<div class="fragment"><pre>00263 {
-00264 <a class="code" href="modules_8h.html#a9">file_cache</a> c;
-00265 readfile(c,filename.c_str());
-00266 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
-00267 }
+<div class="fragment"><pre>00364 {
+00365 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00366 readfile(c,filename.c_str());
+00367 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
+00368 }
</pre></div> </td>
</tr>
</table>
<p>
This deletes the memory allocated to the file.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00281">281</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00382">382</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-<div class="fragment"><pre>00282 {
-00283 }
+<div class="fragment"><pre>00383 {
+00384 }
</pre></div> </td>
</tr>
</table>
<td>
<p>
-Retrieve one line from the file.
+Returns true if the file exists This function will return false if the file could not be opened.
<p>
-This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
+
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00285">285</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00386">386</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00369">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00531">fc</a>.
<p>
-<div class="fragment"><pre>00286 {
-00287 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
-00288 {
-00289 <span class="keywordflow">return</span>(false);
-00290 }
-00291 <span class="keywordflow">else</span>
-00292 {
-00293 <span class="keywordflow">return</span>(true);
-00294 }
-00295 }
+<div class="fragment"><pre>00387 {
+00388 <span class="keywordflow">if</span> (<a class="code" href="classFileReader.html#o0">fc</a>.size() == 0)
+00389 {
+00390 <span class="keywordflow">return</span>(false);
+00391 }
+00392 <span class="keywordflow">else</span>
+00393 {
+00394 <span class="keywordflow">return</span>(true);
+00395 }
+00396 }
</pre></div> </td>
</tr>
</table>
<p>
This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00304">304</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00405">405</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00369">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00531">fc</a>.
<p>
-<div class="fragment"><pre>00305 {
-00306 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
-00307 }
+<div class="fragment"><pre>00406 {
+00407 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>.size();
+00408 }
</pre></div> </td>
</tr>
</table>
<td>
<p>
-
+Retrieve one line from the file.
+<p>
+This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00297">297</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00398">398</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00369">fc</a>.
+References <a class="el" href="modules_8h-source.html#l00531">fc</a>.
<p>
-<div class="fragment"><pre>00298 {
-00299 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#o0">fc</a>.size()))
-00300 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-00301 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
-00302 }
+<div class="fragment"><pre>00399 {
+00400 <span class="keywordflow">if</span> ((x<0) || (x><a class="code" href="classFileReader.html#o0">fc</a>.size()))
+00401 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+00402 <span class="keywordflow">return</span> <a class="code" href="classFileReader.html#o0">fc</a>[x];
+00403 }
</pre></div> </td>
</tr>
</table>
<p>
This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, <a class="el" href="classFileReader.html#a6">FileReader::FileSize</a> returns 0.
<p>
-Definition at line <a class="el" href="modules_8cpp-source.html#l00273">273</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
+Definition at line <a class="el" href="modules_8cpp-source.html#l00374">374</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
<p>
-References <a class="el" href="modules_8h-source.html#l00369">fc</a>, and <a class="el" href="modules_8h-source.html#l00029">file_cache</a>.
+References <a class="el" href="modules_8h-source.html#l00531">fc</a>, and <a class="el" href="modules_8h-source.html#l00030">file_cache</a>.
<p>
-<div class="fragment"><pre>00274 {
-00275 <a class="code" href="modules_8h.html#a9">file_cache</a> c;
-00276 readfile(c,filename.c_str());
-00277 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
-00278 }
+<div class="fragment"><pre>00375 {
+00376 <a class="code" href="modules_8h.html#a10">file_cache</a> c;
+00377 readfile(c,filename.c_str());
+00378 this-><a class="code" href="classFileReader.html#o0">fc</a> = c;
+00379 }
</pre></div> </td>
</tr>
</table>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
- <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a9">file_cache</a> FileReader::fc<code> [private]</code>
+ <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a10">file_cache</a> FileReader::fc<code> [private]</code>
</table>
</td>
</tr>
<p>
<p>
-Definition at line <a class="el" href="modules_8h-source.html#l00369">369</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l00531">531</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
<p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00285">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00262">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00304">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00297">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00273">LoadFile()</a>. </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00386">Exists()</a>, <a class="el" href="modules_8cpp-source.html#l00363">FileReader()</a>, <a class="el" href="modules_8cpp-source.html#l00405">FileSize()</a>, <a class="el" href="modules_8cpp-source.html#l00398">GetLine()</a>, and <a class="el" href="modules_8cpp-source.html#l00374">LoadFile()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
-<hr><address style="align: right;"><small>Generated on Fri Apr 2 14:46:16 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Thu Apr 8 19:13:03 2004 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3-rc3 </small></address>