9.232 ZIP_GET_INFO

Note: Built-In Function Rules     Usage Options

Allows information about a zip file to be retrieved.

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

L

Opt

Working list containing file names or specifications to include. This argument also applies to files in subdirectories, but not to the subdirectory names.

The default is to include all.

The list cannot contain more than 32,767 entries.

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

256

256

 

 

3

L

Opt

Working list containing file names or specifications to exclude. This argument also applies to files in subdirectories, but not to the subdirectory names

The default is to exclude none.

The list cannot contain more than 32,767 entries.

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

This argument is equivalent to zipinfo –x

256

256

 

 

4

A

Opt

Positioning filename

Note: This argument would typically only be used to continue loading the list after a previous return code of OV

1

256

 

 

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return Code

OK = Zip file able to be read okay

NR = No matching files found

ER = An error was encountered

OV = List returned completely filled, but more files in zip file than can fit in the list

2

2

 

 

2

N

Opt

Total size of matching uncompressed files, in bytes

Note: This value is only affected by the list of files to include and exclude. If this BIF is called multiple times for overflow processing, this value will not change.

1

10

0

0

3

N

Opt

Number of matching files

Note: This value is only affected by the list of files to include and exclude. If this BIF is called multiple times for overflow processing, this value will not change.

1

10

0

0

4

L

Opt

Working list to contain file names; will include paths if they exist. List must not contain more than 32,767 entries.

256

256

 

 

5

A

Opt

The last file name in the returned list

1

256

 

 

6

L

Opt

Working list to contain information about the files returned in the file name list. Entry 1 in the file name list relates directly to Entry 1 in this list. This list must have the same number of entries as the file name list.

Formatted:

Start   End   Description

1 - 10   Uncompressed size (bytes)

11 - 18   Date YYYYMMDD

19 - 24   Time HHMMSS

 

18

24

 

 

 

Technical Notes