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 ee136db97..99afbea95 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "14 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -57,7 +57,7 @@ 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 1618 of file modules.h. +Definition at line 1621 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" @@ -66,11 +66,11 @@ Default constructor. .PP This method does not load any file into memory, you must use the LoadFile method after constructing the class this way. .PP -Definition at line 886 of file modules.cpp. +Definition at line 891 of file modules.cpp. .PP .nf -887 { -888 } +892 { +893 } .fi .PP .SS "FileReader::FileReader (\fBstd::string\fP filename)" @@ -79,16 +79,16 @@ Secondary constructor. .PP 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. .PP -Definition at line 879 of file modules.cpp. +Definition at line 884 of file modules.cpp. .PP References fc, and readfile(). .PP .nf -880 { -881 file_cache c; -882 readfile(c,filename.c_str()); -883 this->fc = c; -884 } +885 { +886 file_cache c; +887 readfile(c,filename.c_str()); +888 this->fc = c; +889 } .fi .PP .SS "FileReader::~FileReader ()" @@ -97,11 +97,11 @@ Default destructor. .PP This deletes the memory allocated to the file. .PP -Definition at line 898 of file modules.cpp. +Definition at line 903 of file modules.cpp. .PP .nf -899 { -900 } +904 { +905 } .fi .PP .SH "Member Function Documentation" @@ -110,21 +110,21 @@ Definition at line 898 of file modules.cpp. .PP Returns true if the file exists This function will return false if the file could not be opened. .PP -Definition at line 902 of file modules.cpp. +Definition at line 907 of file modules.cpp. .PP References fc. .PP .nf -903 { -904 if (fc.size() == 0) -905 { -906 return(false); -907 } -908 else -909 { -910 return(true); -911 } -912 } +908 { +909 if (fc.size() == 0) +910 { +911 return(false); +912 } +913 else +914 { +915 return(true); +916 } +917 } .fi .PP .SS "int FileReader::FileSize ()" @@ -133,14 +133,14 @@ Returns the size of the file in lines. .PP 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. .PP -Definition at line 921 of file modules.cpp. +Definition at line 926 of file modules.cpp. .PP References fc. .PP .nf -922 { -923 return fc.size(); -924 } +927 { +928 return fc.size(); +929 } .fi .PP .SS "\fBstd::string\fP FileReader::GetLine (int x)" @@ -149,16 +149,16 @@ Retrieve one line from the file. .PP 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. .PP -Definition at line 914 of file modules.cpp. +Definition at line 919 of file modules.cpp. .PP References fc. .PP .nf -915 { -916 if ((x<0) || ((unsigned)x>fc.size())) -917 return ''; -918 return fc[x]; -919 } +920 { +921 if ((x<0) || ((unsigned)x>fc.size())) +922 return ''; +923 return fc[x]; +924 } .fi .PP .SS "void FileReader::LoadFile (\fBstd::string\fP filename)" @@ -167,23 +167,23 @@ Used to load a file. .PP 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. .PP -Definition at line 890 of file modules.cpp. +Definition at line 895 of file modules.cpp. .PP References fc, and readfile(). .PP .nf -891 { -892 file_cache c; -893 readfile(c,filename.c_str()); -894 this->fc = c; -895 } +896 { +897 file_cache c; +898 readfile(c,filename.c_str()); +899 this->fc = c; +900 } .fi .PP .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 1620 of file modules.h. +Definition at line 1623 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). |