Changes between Version 6 and Version 7 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/File/CFile

Timestamp:

08/23/10 07:47:10 (14 years ago)

Author:

Don Wilson

Comment:

--

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

@@ -20 +20 @@
 }}}
 These constructors construct the file object and attempt to open the file.
+
+
+==== Parameters ====
+ * strFilename - filename
+ * pszFilename - filename
+ * strMode - mode
+ * pszMode - mode
+
+==== Examples ====
 
 {{{
@@ -30 +39 @@
 }}}
 
+{{{
+CFile fileLog("/mnt/fl1/log.txt");
+}}}
+This contructs the object to open later.
+
+== Member Functions ==
+
+=== Open ===
+Opens a specified file, or using the filename already stored in the object.
+
+{{{
+bool Open(const string& strFilename, const string& strMode);
+bool Open(const string& strFilename, const char* pszMode);
+bool Open(const char* pszFilename, const string& strMode);
+bool Open(const char* pszFilename, const char* pszMode);
+bool Open(const char* pszMode);
+}}}
+
 ==== Parameters ====
  * strFilename - filename
@@ -36 +63 @@
  * pszMode - mode
 
-== Member Functions ==
-
-=== Open ===
-Opens a specified file, or using the filename already stored in the object.
-
-{{{
-bool Open(const string& strFilename, const string& strMode);
-bool Open(const string& strFilename, const char* pszMode);
-bool Open(const char* pszFilename, const string& strMode);
-bool Open(const char* pszFilename, const char* pszMode);
-bool Open(const char* pszMode);
-}}}
-
-==== Parameters ====
- * strFilename - filename
- * pszFilename - filename
- * strMode - mode
- * pszMode - mode
-
 ==== Return Value ====
 
@@ -116 +124 @@
 
 ==== Remarks ====
+
+IsReady() will return false if the CTS line is unconnected. Printers or other devices must be wired correctly for applications to be able to use this function to determine their readiness.
 
 ==== Example ====
@@ -160 +170 @@
 === GetFile ===
 
- * FILE* GetFile(void);
+{{{
+FILE* GetFile(void);
+}}}
 
 === Print ===
 
- * void Print(const std::string& fmt, ...);
- * void Print(const char * fmt, va_list& args);
- * void Print(const std::string& fmt, va_list& args);
- * void Print(const char * fmt, va_list& args);
+{{{
+void Print(const std::string& fmt, ...);
+void Print(const char * fmt, va_list& args);
+void Print(const std::string& fmt, va_list& args);
+void Print(const char * fmt, va_list& args);
+}}}
 
 === SetNonBlocking ===
 
- * void SetNonBlocking(void);
-
+{{{
+void SetNonBlocking(void);
+}}}
 
 
 === Read ===
 
- * bool Read(void * ptr, size_t size);
+{{{
+bool Read(void * ptr, size_t size);
+}}}
 
 === Write ===
 
- * bool Write(void * buf, size_t size);
+{{{
+bool Write(void * buf, size_t size);
+}}}
 
 === GetBytesRead ===
 
- * size_t GetBytesRead(void);
+{{{
+size_t GetBytesRead(void);
+}}}
 
 === GetbytesWritten ===
 
- * size_t GetBytesWritten(void);
+{{{
+size_t GetBytesWritten(void);
+}}}
 
 === Seek ===
 
- * bool Seek(long int offset, long int origin = SEEK_SET);
-
-
+{{{
+bool Seek(long int offset, long int origin = SEEK_SET);
+}}}
+