Changes between Version 13 and Version 14 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/File/CFile

Timestamp:

08/23/10 09:05:26 (14 years ago)

Author:

Don Wilson

Comment:

--

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

@@ -237 +237 @@
 ==== 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.
+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. '''The main board COM3 is not currently supported by this function.'''
 
 ==== Example ====
@@ -287 +287 @@
 
 === 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);
+Outputs text which may include format specifiers. For each format specifier an additional parameter must be provided.
+{{{
+void Print(const string& strFormat, ...);
+void Print(const char* pszFormat, ...);
+void Print(const string& strFormat, va_list& args);
+void Print(const char* pszFormat, va_list& args);
+}}}
+
+==== Parameters ====
+
+ * strFormat - string to output, may include format specifiers such as C printf statements
+ * pszFormat - pointer to null-terminated string to output, may include format specifiers
+ * ... - variable list of arguments that should match up with format specifiers
+ * args - variable list of aguments structure
+
+==== Return Value ====
+
+Function does not return a value.
+
+==== Remarks ====
+
+==== Examples ====
+{{{
+string str = "Hello World\r\n";
+file.Print(str);
+}}}
+
+{{{
+int n = 5;
+string str = "ABC";
+file.Print("Number: %d String %s\r\n", n, str.c_str());
+}}}
+
+{{{
+// This is a function to log update data to two devices
+// g_fileLog1, and g_fileLog2 are globals that should already have been opened before this function is called.
+void LogOutput(const char* fmt, ...)
+{
+   va_list args;
+   va_start(args, fmt);
+
+   g_fileLog1.Print(fmt, args);
+   g_fileLog2.Print(fmt, args);
+}
+
 }}}