summaryrefslogtreecommitdiff
path: root/docs/man/man3/FileReader.3
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-12-12 13:32:15 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-12-12 13:32:15 +0000
commit097b2479d0393d8a8bada4a50708d7a2404045ca (patch)
tree8e624ea3c2035ebf8c64adfd3599a0fe1dce1556 /docs/man/man3/FileReader.3
parent277fc183721767efbce4b4cb1fc716c5f67d4752 (diff)
Added new docs for class SocketEngine
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2339 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3/FileReader.3')
-rw-r--r--docs/man/man3/FileReader.380
1 files changed, 40 insertions, 40 deletions
diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3
index 09067f8f8..bf779fb9e 100644
--- a/docs/man/man3/FileReader.3
+++ b/docs/man/man3/FileReader.3
@@ -1,4 +1,4 @@
-.TH "FileReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
+.TH "FileReader" 3 "12 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -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 988 of file modules.cpp.
+Definition at line 961 of file modules.cpp.
.PP
.nf
-989 {
-990 }
+962 {
+963 }
.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 981 of file modules.cpp.
+Definition at line 954 of file modules.cpp.
.PP
References fc.
.PP
.nf
-982 {
-983 file_cache c;
-984 readfile(c,filename.c_str());
-985 this->fc = c;
-986 }
+955 {
+956 file_cache c;
+957 readfile(c,filename.c_str());
+958 this->fc = c;
+959 }
.fi
.PP
.SS "FileReader::~FileReader ()"
@@ -97,11 +97,11 @@ Default destructor.
.PP
This deletes the memory allocated to the file.
.PP
-Definition at line 1000 of file modules.cpp.
+Definition at line 973 of file modules.cpp.
.PP
.nf
-1001 {
-1002 }
+974 {
+975 }
.fi
.PP
.SH "Member Function Documentation"
@@ -110,21 +110,21 @@ Definition at line 1000 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 1004 of file modules.cpp.
+Definition at line 977 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 }
+978 {
+979 if (fc.size() == 0)
+980 {
+981 return(false);
+982 }
+983 else
+984 {
+985 return(true);
+986 }
+987 }
.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 1023 of file modules.cpp.
+Definition at line 996 of file modules.cpp.
.PP
References fc.
.PP
.nf
-1024 {
-1025 return fc.size();
-1026 }
+997 {
+998 return fc.size();
+999 }
.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 1016 of file modules.cpp.
+Definition at line 989 of file modules.cpp.
.PP
References fc.
.PP
.nf
-1017 {
-1018 if ((x<0) || ((unsigned)x>fc.size()))
-1019 return '';
-1020 return fc[x];
-1021 }
+990 {
+991 if ((x<0) || ((unsigned)x>fc.size()))
+992 return '';
+993 return fc[x];
+994 }
.fi
.PP
.SS "void FileReader::LoadFile (\fBstd::string\fP filename)"
@@ -167,16 +167,16 @@ 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 992 of file modules.cpp.
+Definition at line 965 of file modules.cpp.
.PP
References fc.
.PP
.nf
-993 {
-994 file_cache c;
-995 readfile(c,filename.c_str());
-996 this->fc = c;
-997 }
+966 {
+967 file_cache c;
+968 readfile(c,filename.c_str());
+969 this->fc = c;
+970 }
.fi
.PP
.SH "Member Data Documentation"