Changes between Version 10 and Version 11 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/File/CFile

Timestamp:

08/23/10 08:29:13 (14 years ago)

Author:

Don Wilson

Comment:

--

Docs/Prog/Manual/ApplicationLibraries/lib825ev/File/CFile

@@ -144 +144 @@
 
 === ReadLine ===
-
-{{{
-bool ReadLine(std::string& str);
-}}}
+Reads a text file a line at a time.
+{{{
+bool ReadLine(std::string& strLine);
+}}}
+
+==== Parameters ====
+
+ * strLine - string reference to return line read
+
+==== Return Value ====
+
+Returns true if line read, false if end of file
+
+==== Remarks ====
+
+==== Example ====
+
+{{{
+CFile file("/mnt/nand/apps/test/config.txt", "r");
+if(file.IsOpen())
+{
+   string strLine;
+   while(file.ReadLine(strLine) == true)
+   {
+       if(strLine.substr(0, 7) == "Setting")
+       {
+           // TODO Parse the settings line
+       }
+   }
+   file.Close();
+}
 
 === DeleteFile ===