Zip File - Extract

Extracts files from a Zip archive.

Action ID:
Action Category:
Action List Syntax:

131
ZIP File
ZipFile.Extract (<<ZIPFILE>>, <<FILESTOEXTRACT>>, <<UNZIPFOLDER>> )

Settings

Zip filename:

The full path and filename of the Zip file.

Files to extract:

The files that you want to extract from the Zip file. To specify multiple files, use a delimited list.

For each file that you want to extract, you must specify the file's path within the Zip file. For example, to extract the foo.txt file from the lala subfolder in the Zip file, you would enter "lala\foo.txt".

You can also use wildcards to specify multiple files. For example, you could extract all files from the Zip file by entering "*.*" in this field.

Delimiter:

The delimiter that you used to separate items in the File to extract field. If the text in the File to extract field is not a delimited list, you can leave this field blank.

Unzip to folder:

The folder that the files will be extracted to.

Recurse subfolders

Select this option if you want AutoPlay to recurse into subfolders within the Zip file as it searches for files to extract. This is primarily useful when wildcards are used in the File to extract field.

Use internal zip folder names

Select this option if you want AutoPlay to recreate the internal file structure of the Zip file as it extracts the files to the user's system.

Use password

Select this option if you need to specify a password in order to extract files from the Zip file.

Password:

The Zip password to use. This field is only available if the Use password option is enabled.

Overwrite options:

What to do if any files being extracted already exist in the unzip-to folder. Choose from:

Never Overwrite

-

Do not overwrite any files.

Overwrite if Newer

-

Only overwrite a file if the one being extracted is newer.

Always Overwrite

-

Overwrite all existing files with the ones being extracted.

Dialog

Show dialog

Select this option to display a progress dialog while the files are being extracted from the Zip file.

Dialog title:

The text to display in the dialog's title bar.

This field is only available when the Show dialog option is enabled.

Error Codes

Value
(%LastErrorNum%)

Simple Message
(%LastErrorMsg%)

Verbose Message
(%LastErrorDetails%)

0 (OK)

 

 

1

MSG_ERR_ZIP_FILE_EXTRACT

MSG_ERR_ZIP_FILE_EXTRACT
MSG_ERR_FILE_NOT_FOUND
<<ZIPFILE>>

2

MSG_ERR_ZIP_FILE_EXTRACT

MSG_ERR_ZIP_FILE_EXTRACT
MSG_ERR_CREATE_DIR
<<UNZIPFOLDER>>

3

MSG_ERR_ZIP_FILE_EXTRACT

MSG_ERR_ZIP_FILE_EXTRACT
MSG_ERR_CORRUPT_FILE
<<ZIPFILE>>

4

MSG_ERR_ZIP_FILE_EXTRACT

MSG_ERR_ZIP_FILE_EXTRACT
MSG_ERR_EXTRACTING
<<ZIPFILE>>

<<UNZIPFOLDER>>

10

MSG_ERR_ZIP_FILE_EXTRACT

MSG_ERR_ZIP_FILE_EXTRACT
MSG_ERR_EXTRACT_STAGE
<<ZIPFILE>>

<<UNZIPFOLDER>>

Examples

Unzipping files from an archive