]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/man/man3/FileReader.3
Re-added the dot graphs again
[user/henk/code/inspircd.git] / docs / man / man3 / FileReader.3
index 677e59b5d10f578fc729c7ccf2733ca08b5f30d9..d22ca39121b164344a0534c13bba96398e52280b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "FileReader" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*-
+.TH "FileReader" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -57,100 +57,100 @@ Caches a text file into memory and can be used to retrieve lines from it.
 
 This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. 
 .PP
-Definition at line 774 of file modules.h.
+Definition at line 1236 of file modules.h.
 .SH "Constructor & Destructor Documentation"
 .PP 
 .SS "FileReader::FileReader ()"
 .PP
-Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 732 of file modules.cpp.
+Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 1023 of file modules.cpp.
 .PP
 .nf
-733 {
-734 }
+1024 {
+1025 }
 .fi
 .SS "FileReader::FileReader (std::string filename)"
 .PP
-Secondary constructor. 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, \fBFileReader::FileSize\fP returns 0.Definition at line 725 of file modules.cpp.
+Secondary constructor. 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, \fBFileReader::FileSize\fP returns 0.Definition at line 1016 of file modules.cpp.
 .PP
 References fc, and file_cache.
 .PP
 .nf
-726 {
-727         file_cache c;
-728         readfile(c,filename.c_str());
-729         this->fc = c;
-730 }
+1017 {
+1018         file_cache c;
+1019         readfile(c,filename.c_str());
+1020         this->fc = c;
+1021 }
 .fi
 .SS "FileReader::~\fBFileReader\fP ()"
 .PP
-Default destructor. This deletes the memory allocated to the file.Definition at line 744 of file modules.cpp.
+Default destructor. This deletes the memory allocated to the file.Definition at line 1035 of file modules.cpp.
 .PP
 .nf
-745 {
-746 }
+1036 {
+1037 }
 .fi
 .SH "Member Function Documentation"
 .PP 
 .SS "bool FileReader::Exists ()"
 .PP
-Returns true if the file exists This function will return false if the file could not be opened. Definition at line 748 of file modules.cpp.
+Returns true if the file exists This function will return false if the file could not be opened. Definition at line 1039 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-749 {
-750         if (fc.size() == 0)
-751         {
-752                 return(false);
-753         }
-754         else
-755         {
-756                 return(true);
-757         }
-758 }
+1040 {
+1041         if (fc.size() == 0)
+1042         {
+1043                 return(false);
+1044         }
+1045         else
+1046         {
+1047                 return(true);
+1048         }
+1049 }
 .fi
 .SS "int FileReader::FileSize ()"
 .PP
-Returns the size of the file in lines. 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.Definition at line 767 of file modules.cpp.
+Returns the size of the file in lines. 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.Definition at line 1058 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-768 {
-769         return fc.size();
-770 }
+1059 {
+1060         return fc.size();
+1061 }
 .fi
 .SS "std::string FileReader::GetLine (int x)"
 .PP
-Retrieve one line from the file. 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.Definition at line 760 of file modules.cpp.
+Retrieve one line from the file. 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.Definition at line 1051 of file modules.cpp.
 .PP
 References fc.
 .PP
 .nf
-761 {
-762         if ((x<0) || (x>fc.size()))
-763                 return '';
-764         return fc[x];
-765 }
+1052 {
+1053         if ((x<0) || (x>fc.size()))
+1054                 return '';
+1055         return fc[x];
+1056 }
 .fi
 .SS "void FileReader::LoadFile (std::string filename)"
 .PP
-Used to load a file. 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, \fBFileReader::FileSize\fP returns 0.Definition at line 736 of file modules.cpp.
+Used to load a file. 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, \fBFileReader::FileSize\fP returns 0.Definition at line 1027 of file modules.cpp.
 .PP
 References fc, and file_cache.
 .PP
 .nf
-737 {
-738         file_cache c;
-739         readfile(c,filename.c_str());
-740         this->fc = c;
-741 }
+1028 {
+1029         file_cache c;
+1030         readfile(c,filename.c_str());
+1031         this->fc = c;
+1032 }
 .fi
 .SH "Member Data Documentation"
 .PP 
 .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
 .PP
-Definition at line 776 of file modules.h.
+Definition at line 1238 of file modules.h.
 .PP
 Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().