File.delete - Revision history

JoeStrout: fixed formatting

2021-09-28T01:09:25Z

fixed formatting

JoeStrout: added bug note

2021-09-28T01:09:07Z

added bug note

JoeStrout: Created page with "The file.delete method deletes a file or empty directory from disk. === Arguments === {| class="wikitable" |- ! Parameter Name !! Default Value !! Meaning |- | pa..."

2021-07-12T17:08:16Z

Created page with "The <c>file.delete</c> method deletes a file or empty directory from disk. === Arguments === {| class="wikitable" |- ! Parameter Name !! Default Value !! Meaning |- | pa..."

New page

The <c>[[file]].delete</c> method deletes a file or empty directory from disk.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Default Value !! Meaning
|-
| path || "" || file name, partial path, or absolute path to file or directory to be deleted
|}

If given a file name or partial path, it will be interpreted relative to the current working directory (see <c>[[file.curdir]]</c>).

=== Result ===

If the file was successfully deleted, this method returns [[true]] (1).
Otherwise, it returns [[false]] (0). This can happen if the specified file does not exist, if it is a directory that is not empty, or if some other low-level issue occurs (for example, the file is locked).

== Example ==

The following attempts to delete a file called "test.txt" in the [[file.curdir|current directory]].

<ms>file.delete "test.txt"</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]

@@ Line 19: / Line 19: @@
 == Known Issue ==
-In version 1.0 of Mini Micro, `file.delete` fails on a directory (even if empty), returning "Error: file not found".
+In version 1.0 of Mini Micro, <c>file.delete</c> fails on a directory (even if empty), returning "Error: file not found".
 == Example ==

@@ Line 16: / Line 16: @@
 If the file was successfully deleted, this method returns [[true]] (1).
 Otherwise, it returns [[false]] (0).  This can happen if the specified file does not exist, if it is a directory that is not empty, or if some other low-level issue occurs (for example, the file is locked).
 == Example ==