diff options
Diffstat (limited to 'docs/man/man3/FileReader.3')
| -rw-r--r-- | docs/man/man3/FileReader.3 | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index a69617742..8373506b9 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "7 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 1186 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 988 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 1004 of file modules.cpp. .PP .nf -989 { -990 } +1005 { +1006 } .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 981 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 997 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -982 { -983 file_cache c; -984 readfile(c,filename.c_str()); -985 this->fc = c; -986 } +998 { +999 file_cache c; +1000 readfile(c,filename.c_str()); +1001 this->fc = c; +1002 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 1000 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 1016 of file modules.cpp. .PP .nf -1001 { -1002 } +1017 { +1018 } .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 1004 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 1020 of file modules.cpp. .PP References fc. .PP .nf -1005 { -1006 if (fc.size() == 0) -1007 { -1008 return(false); -1009 } -1010 else -1011 { -1012 return(true); -1013 } -1014 } +1021 { +1022 if (fc.size() == 0) +1023 { +1024 return(false); +1025 } +1026 else +1027 { +1028 return(true); +1029 } +1030 } .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 1023 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 1039 of file modules.cpp. .PP References fc. .PP .nf -1024 { -1025 return fc.size(); -1026 } +1040 { +1041 return fc.size(); +1042 } .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 1016 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 1032 of file modules.cpp. .PP References fc. .PP .nf -1017 { -1018 if ((x<0) || (x>fc.size())) -1019 return ''; -1020 return fc[x]; -1021 } +1033 { +1034 if ((x<0) || (x>fc.size())) +1035 return ''; +1036 return fc[x]; +1037 } .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 992 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 1008 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -993 { -994 file_cache c; -995 readfile(c,filename.c_str()); -996 this->fc = c; -997 } +1009 { +1010 file_cache c; +1011 readfile(c,filename.c_str()); +1012 this->fc = c; +1013 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 1188 of file modules.h. +Definition at line 1238 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). |