.FILE CREATE ARCHIVE

This subroutine creates an archive of the specified files, in either TAR or TGZ format.

Usage:

      PASS         <error_message>            FIELD            SHARE? Y
      PASS         <archive_file>             FIELD            SHARE? N
      PASS         <source_directory>         FIELD            SHARE? N
      GOSUB    --- .FILE CREATE ARCHIVE
      *        check for errors
      IF       --- .FILE CREATE ARCHIVE       NE

Description:

This subroutine creates an archive of the specified files, in either TAR or TGZ format. All parameters are required, if any are missing the subroutine will CANCEL.

<error_message> contains additional error information if the command fails (Required). Must be PASSed with Share "Y".

<archive_file> is the archive to be created (Required). This should include the full path to the file. Any required directories will be created. If the file does not have a '.tgz' extension (case sensitive), it will be created in Unix Tar format. If this file already exists, it will be overwritten.

<source_directory> is the source directory to be archived. (Required). Note that this must be a directory name, wild cards or specific files are not supported.

If --- .FILE CREATE ARCHIVE contains 'Archive create failed', you can check the <error_message> field for more information on why the create failed.

This command is run by the appx engine, not by 'shelling out' to the O/S level, therefore the archive 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.

-- JeanNeron - 2012-01-24