summaryrefslogtreecommitdiff
path: root/docs/man/man3/FileReader.3
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-04-15 19:31:08 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-04-15 19:31:08 +0000
commit674c868b225f0c2c0a8f7879dbaa322a8c539bec (patch)
tree38ad38d48e66179583ae02912c327f54779615ab /docs/man/man3/FileReader.3
parent517dd987a78aafda52057f1f6b763a278e3384b2 (diff)
New docs for API:
int Module::OnRawMode(userrec* user, char mode, std::string param, bool adding, int pcnt); int Module::OnCheckInvite(userrec* user, chanrec* chan); int Module::OnCheckKey(userrec* user, chanrec* chan, std::string keygiven); int Module::OnCheckLimit(userrec* user, chanrec* chan); int Module::OnCheckBan(userrec* user, chanrec* chan); void Module::OnStats(char symbol); int Module::OnChangeLocalUserHost(userrec* user, std::string newhost); int Module::OnChangeLocalUserGECOS(userrec* user, std::string newhost); int Module::OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic); git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1106 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3/FileReader.3')
-rw-r--r--docs/man/man3/FileReader.382
1 files changed, 41 insertions, 41 deletions
diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3
index ebfdece4a..2921a6001 100644
--- a/docs/man/man3/FileReader.3
+++ b/docs/man/man3/FileReader.3
@@ -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 924 of file modules.h.
+Definition at line 980 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 861 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 870 of file modules.cpp.
.PP
.nf
-862 {
-863 }
+871 {
+872 }
.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 854 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 863 of file modules.cpp.
.PP
References fc, and file_cache.
.PP
.nf
-855 {
-856 file_cache c;
-857 readfile(c,filename.c_str());
-858 this->fc = c;
-859 }
+864 {
+865 file_cache c;
+866 readfile(c,filename.c_str());
+867 this->fc = c;
+868 }
.fi
.SS "FileReader::~\fBFileReader\fP ()"
.PP
-Default destructor. This deletes the memory allocated to the file.Definition at line 873 of file modules.cpp.
+Default destructor. This deletes the memory allocated to the file.Definition at line 882 of file modules.cpp.
.PP
.nf
-874 {
-875 }
+883 {
+884 }
.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 877 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 886 of file modules.cpp.
.PP
References fc.
.PP
.nf
-878 {
-879 if (fc.size() == 0)
-880 {
-881 return(false);
-882 }
-883 else
-884 {
-885 return(true);
-886 }
-887 }
+887 {
+888 if (fc.size() == 0)
+889 {
+890 return(false);
+891 }
+892 else
+893 {
+894 return(true);
+895 }
+896 }
.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 896 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 905 of file modules.cpp.
.PP
References fc.
.PP
.nf
-897 {
-898 return fc.size();
-899 }
+906 {
+907 return fc.size();
+908 }
.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 889 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 898 of file modules.cpp.
.PP
References fc.
.PP
.nf
-890 {
-891 if ((x<0) || (x>fc.size()))
-892 return '';
-893 return fc[x];
-894 }
+899 {
+900 if ((x<0) || (x>fc.size()))
+901 return '';
+902 return fc[x];
+903 }
.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 865 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 874 of file modules.cpp.
.PP
References fc, and file_cache.
.PP
.nf
-866 {
-867 file_cache c;
-868 readfile(c,filename.c_str());
-869 this->fc = c;
-870 }
+875 {
+876 file_cache c;
+877 readfile(c,filename.c_str());
+878 this->fc = c;
+879 }
.fi
.SH "Member Data Documentation"
.PP
.SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
.PP
-Definition at line 926 of file modules.h.
+Definition at line 982 of file modules.h.
.PP
Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().