9.228 ZIP_EXTRACT

Note: Built-In Function Rules     Usage Options

Allows files to be extracted from a .zip file.

Also See

ZIP Built-In Function Note

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Zip file/path name

If no path is specified, the file is assumed to be in the temporary directory.

If file name does not have an extension, .zip will be appended.

1

256



2

A

Req

Directory to extract to.

Note: This directory will be created if necessary (and possible)

1

256



3

L

Opt

Working list containing file names or specifications to extract. This argument also applies to files in sub-directories, but not to the sub-directory names.

The default is to extract all.

Note: If the list is empty, the default will be used.

256

256



4

A

Opt

Overwrite existing files.

N = Never (unzip -n)

U = Only if newer (unzip -uo)

Y = Always (unzip -o)

Default is Y.

Note: When using option U, be careful of unzipping in one time zone a zip file created in another -- ZIP archives other than those created the BIF ZIP_ADD (or Zip 2.1 or later) contain no time zone information, and a 'newer' file from an eastern time zone may, in fact, be older.

1

1



5

L

Opt

Working list containing file names or specifications to exclude. This argument also applies to files in sub-directories, but not to the sub-directory names

The default is to exclude none.

Note: If the list is empty, the default will be used.

This argument is equivalent to unzip -x

256

256



Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return Code

OK = Zip file extracted successfully

ER = An error was encountered

NR = No matching files found

2

2



Technical Notes