From 674c868b225f0c2c0a8f7879dbaa322a8c539bec Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 15 Apr 2005 19:31:08 +0000 Subject: 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 --- docs/module-doc/classFileReader.html | 96 ++++++++++++++++++------------------ 1 file changed, 48 insertions(+), 48 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index aac9ad51a..f739de262 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -47,7 +47,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 924 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 980 of file modules.h.

Constructor & Destructor Documentation

@@ -77,10 +77,10 @@ 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. +Definition at line 870 of file modules.cpp.

-

00862 {
-00863 }
+
00871 {
+00872 }
 
@@ -114,15 +114,15 @@ 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, FileReader::FileSize returns 0.

-Definition at line 854 of file modules.cpp. +Definition at line 863 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00855 {
-00856         file_cache c;
-00857         readfile(c,filename.c_str());
-00858         this->fc = c;
-00859 }
+
00864 {
+00865         file_cache c;
+00866         readfile(c,filename.c_str());
+00867         this->fc = c;
+00868 }
 
@@ -155,10 +155,10 @@ Default destructor.

This deletes the memory allocated to the file.

-Definition at line 873 of file modules.cpp. +Definition at line 882 of file modules.cpp.

-

00874 {
-00875 }
+
00883 {
+00884 }
 
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul

-Definition at line 877 of file modules.cpp. +Definition at line 886 of file modules.cpp.

-References fc. +References fc.

-

00878 {
-00879         if (fc.size() == 0)
-00880         {
-00881                 return(false);
-00882         }
-00883         else
-00884         {
-00885                 return(true);
-00886         }
-00887 }
+
00887 {
+00888         if (fc.size() == 0)
+00889         {
+00890                 return(false);
+00891         }
+00892         else
+00893         {
+00894                 return(true);
+00895         }
+00896 }
 
@@ -238,13 +238,13 @@ 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. +Definition at line 905 of file modules.cpp.

-References fc. +References fc.

-

00897 {
-00898         return fc.size();
-00899 }
+
00906 {
+00907         return fc.size();
+00908 }
 
@@ -278,15 +278,15 @@ 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. +Definition at line 898 of file modules.cpp.

-References fc. +References fc.

-

00890 {
-00891         if ((x<0) || (x>fc.size()))
-00892                 return "";
-00893         return fc[x];
-00894 }
+
00899 {
+00900         if ((x<0) || (x>fc.size()))
+00901                 return "";
+00902         return fc[x];
+00903 }
 
@@ -320,15 +320,15 @@ 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, FileReader::FileSize returns 0.

-Definition at line 865 of file modules.cpp. +Definition at line 874 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00866 {
-00867         file_cache c;
-00868         readfile(c,filename.c_str());
-00869         this->fc = c;
-00870 }
+
00875 {
+00876         file_cache c;
+00877         readfile(c,filename.c_str());
+00878         this->fc = c;
+00879 }
 
@@ -354,14 +354,14 @@ References fc, and

-Definition at line 926 of file modules.h. +Definition at line 982 of file modules.h.

-Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). +Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().


The documentation for this class was generated from the following files: -
Generated on Fri Apr 15 14:50:49 2005 for InspIRCd by +
Generated on Fri Apr 15 19:30:21 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.2.3