Changes between Version 20 and Version 21 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/File/CFile

Timestamp:

08/23/10 14:03:30 (14 years ago)

Author:

Don Wilson

Comment:

--

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

@@ -305 +305 @@
 
 === GetFile ===
+Get the file handle of the member FILE.
 
 {{{
 FILE* GetFile(void);
 }}}
+==== Parameters ====
+Function does not accept any parameters
+==== Return Value ====
+
+Function returns FILE handle of underlying FILE.
+
+==== Remarks ====
+
+==== Example ====
+
+{{{
+CFile file("/tmp/test", "w");
+if(file.IsOpen())
+{
+   fprintf(file.GetFile(), "This is a test\r\n");
+   file.Close();
+}
+}}}
+In the above example the fprintf could be replaced with ''file.Print("This is a test\r\n");'' eliminating the need for the GetFile() call.
 
 === Print ===
@@ -390 +410 @@
 
 === Read ===
-
-{{{
-bool Read(void * ptr, size_t size);
-}}}
+Reads a binary block of data from a file.
+{{{
+bool Read(void *pData, size_t nSize);
+}}}
+
+==== Parameters ===
+ * pData - pointer to memory to store data received. The application must have sufficient memory allocated.
+ * nSize - number of bytes to read.
+
+==== Return Value ====
+
+Function returns true if the specified number of bytes were read
+
+==== Remarks ====
+
+==== Example ====
+
 
 === Write ===
-
-{{{
-bool Write(void * buf, size_t size);
-}}}
+Writes a binary block of data to a file.
+{{{
+bool Write(void *pData, size_t nSize);
+}}}
+
+==== Parameters ====
+ * pData - pointer to memory to store data received. The application must have sufficient memory allocated.
+ * nSize - number of bytes to read.
+
+==== Return Value ====
+
+Function returns true if the specified number of bytes were written.
+
+==== Remarks ====
+
+==== Example ====
 
 === GetBytesRead ===
-
+Returns how may bytes were read from previous Read function.
 {{{
 size_t GetBytesRead(void);
 }}}
 
+==== Parameters ====
+Function does not accept any parameters.
+
+==== Return Value ====
+
+Function returns number of bytes read from the previous read operation.
+
+==== Example ====
+
+
 === GetbytesWritten ===
+Returns how may bytes were written from previous Write function.
 
 {{{
@@ -413 +469 @@
 }}}
 
+==== Parameters ====
+Function does not accept any parameters.
+
+==== Return Value ====
+
+Function returns number of bytes read from the previous read operation.
+
+==== Example ====
+
+
 === Seek ===