0LASubrFileExtractArchive < Main

Tags: view all tags
---+ .FILE EXTRACT ARCHIVE

_This subroutine extracts all the files from a previously created archive._

%TOC%
---++ Usage:
<pre>      PASS         &lt;error_message&gt;            FIELD            SHARE? Y
      PASS         &lt;archive_file&gt;             FIELD            SHARE? N
      PASS         &lt;dest_directory&gt;           FIELD            SHARE? N
      GOSUB    --- .FILE EXTRACT ARCHIVE
      *        check for errors
      IF       --- .FILE EXTRACT ARCHIVE      NE

</pre>

---++ Description:

This subroutine extracts all the files from a previously created archive (see [[0LASubrFileCreateArchive][.FILE CREATE ARCHIVE]]). 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;archive_file&gt; is the archive to be extracted (Required). This should include the full path to the file.

&lt;dest_directory&gt; is the target directory where the files should be extracted (Required). Any required directories will be created.

If --- .FILE EXTRACT ARCHIVE contains 'Archive extract failed', you can check the &lt;error_message&gt; field for more information on why the extract failed.

This command is run by the appx engine, not by 'shelling out' to the O/S level, therefore the extracted files 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. *The extracted files will be owned by the current user, who must have sufficient permission in the destination directory to take ownership of the files.*
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2012-01-25
Topic revision: r4 - 2017-12-05 - JeanNeron