File.copy - Revision history

JoeStrout: /* Example */

2022-01-12T18:17:26Z

Example

Mantic: Added some known limitations on error returning.

2021-01-24T03:14:01Z

Added some known limitations on error returning.

Mantic: First draft of file.copy.

2021-01-24T02:50:05Z

First draft of file.copy.

New page

In [[Mini Micro]] and [[command-line MiniScript]], the <c>[[file]].copy</c> function copies a file on the system.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| sourceFilePath|| absolute or relative path to the source file
|-
| targetFilePath || absolute or relative path of the target file
|}

{| class="wikitable"
|-
! Return !! Meaning
|-
| <i>null</i> || File was copied successfully, or the source file was not found. (Use <c>[[file.exists]]</c> to check if the source file is present first.)
|-
| "Error: target file already exists" || Target file already exists. <c>file.copy</c> won't override existing files.
|-
| "Error: target disk not found" || ''targetFilePath'' cannot be navigated to, so no copy can be made.
|}

== Example ==

This copies a file from the current working directory, to a directory just above it:

<ms>if file.exists("myfile.txt") then
ret = file.copy("myfile.txt", "../mycopy.txt")
if ret == null then
print "Copy successful!"
else
print "Copy failed: " + ret
end if
end if</ms>

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

@@ Line 34: / Line 34: @@
 <ms>if file.exists("myfile.txt") then
-   ret = file.copy("myfile.txt", "../mycopy.txt")
+   err = file.copy("myfile.txt", "../mycopy.txt")
-   if ret == null and file.exists("../mycopy.txt") then
+   if err == null and file.exists("../mycopy.txt") then
      print "Copy successful!"
    else
-     print "Copy failed: " + ret
+     print "Copy failed: " + err
    end if

@@ Line 24: / Line 24: @@
 |}
+== Current limitations ==
 == Example ==
@@ Line 31: / Line 33: @@
 <ms>if file.exists("myfile.txt") then
    ret = file.copy("myfile.txt", "../mycopy.txt")
    if ret == null then
      print "Copy successful!"
    else
      print "Copy failed: " + ret
    end if
 end if</ms>
 [[Category:Mini Micro]]
 [[Category:Command-Line MiniScript]]