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

Timestamp:

08/23/10 08:45:48 (14 years ago)

Author:

Don Wilson

Comment:

--

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

@@ -178 +178 @@
 
 === DeleteFile ===
-
-{{{
-static bool DeleteFile(std::string& filepath);
-static bool DeleteFile(const char* filepath);
+Deletes a file
+{{{
+static bool DeleteFile(const string& strFilename);
+static bool DeleteFile(const char* pszFilename);
 
 bool DeleteFile(void);
 }}}
-
+==== Parameters ====
+ * strFilename - string filename to delete
+ * pszFilename - pointer to null terminated character array filename to delete
+
+==== Return value ====
+Returns true if successful, false if not successful.
+
+==== Remarks ====
+
+Versions of this fuctions that accept a filename are static so they do not require an CFile object.
+
+==== Examples ====
+
+{{{
+string str = "/tmp/tmpfile";
+CFile::DeleteFile(str);
+}}}
+
+{{{
+if(CFile::DeleteFile("/tmp/tmpfile") == false)
+{
+   DisplayText(0, 0, "Delete file error");
+}
+}}}
+
+{{{
+CFile file("/tmp/tmpfile", "w");
+if(file.IsOpen())
+{
+   file.Print("This will not exist very long\r\n");
+   SleepSeconds(1);
+   file.Close();
+   SleepSeconds(1);
+   file.DeleteFile();
+}
+}}}
 
 === IsReady ===