0LASubrFileCopy < Main

Tags: view all tags
---+ .FILE COPY

_This subroutine will copy a file from one location to another, creating any required directories._

<br />%TOC%
---++ Usage:

<pre>      PASS         &lt;error_message&gt;            FIELD            SHARE? Y
      PASS         &lt;source_file&gt;              FIELD            SHARE? N
      PASS         &lt;dest_file&gt;                FIELD            SHARE? N
      GOSUB    --- .FILE COPY
      *        check for errors
      IF       --- .FILE COPY                 NE
</pre>

---++ Description:

This subroutine will copy a file from one location to another, creating any required directories. All parameters are required, if any are missing the subroutine will CANCEL.

&lt;error_message&gt; contains additional error information if the command fails (Required). Must be PASSed with Share "Y".

&lt;source_file&gt; is the source file to be copied (Required).

&lt;dest_file&gt; is the location where the file should be copied to (Required). This must include the destination file name, ie, you cannot just specifiy a target directory.

If --- .FILE COPY contains 'File Copy Failed', you can check the &lt;error_message&gt; field for more information on why the copy failed. This routine will not overwrite an existing file, if you want to replace an existing file you can use [[0LASubrFileDelete][.FILE DELETE]] to delete the destination first.  

This command is run by the appx engine, not by 'shelling out' to the O/S level, therefore the destination file will have the permissions of the engine. On Linux/Unix systems, if the 'setuid' bit is set, then those will be the permissions of user 'appx'. If you do not have the 'setuid' bit set, then the those will be the permissions of whatever user you have the engine configured to impersonate. On Windows the permissions will be that of the current user.
---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.JeanNeron - 2012-01-24
Topic revision: r4 - 2013-05-01 - JeanNeron