zipAddFileList (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for managing archives

Adding a file that is already found in the archive

Subscript of files in the archive

Progress Bar

See also

zipAddFileList (Function)

In french: zipAjouteListeFichier

Adds a list of files (of any type) into an archive in ZIP, CAB, WDZ or 7z, TAR ou TGZ (TAR.GZ) format and compresses it. This function is faster than zipAddFile run for each file.

Versions 18 and later

This function now supports the 7z format.

New in version 18

This function now supports the 7z format.

Versions 21 and later

This function now supports the TAR and TGZ (TAR.GZ) formats.

New in version 21

This function now supports the TAR and TGZ (TAR.GZ) formats.

Example

// Create an archive and add an element
// With progress bar displayed in a Progress Bar control
MyArchive is zipArchive
NumZipErr is int

NumZipErr = zipCreate(MyArchive,"C:\Doc\Archive\ArchiveFile.zip")
IF NumZipErr = 0 THEN
NumZipErr = zipAddFileList(MyArchive, "C:\doc\Image\House.BMP" + CR + ...
"C:\My Projects\WDStock\WDStock.wdp", zipDrive, PROGBAR_Progress)
IF NumZipErr <> 0 THEN
Error(zipMsgError(NumZipErr))
END
zipClose(MyArchive)
ELSE
Error(zipMsgError(NumZipErr))
END

Syntax

Adding a list of files (files separated by CR) Hide the details

<Result> = zipAddFileList(<Archive> , <Path of files to add> [, <Path section to store> [, <Progress bar management>]])

<Result>: Integer

0 if the addition was performed,
An error code (value greater than 0) otherwise. See the Remarks for more details.

<Archive>: Character string (with quotes) or zipArchive variable

Name of the archive into which the files will be added.
This name can correspond to:
the name of an archive, defined by zipOpen or zipCreate.
Versions 15 and later
the name of a zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

<Path of files to add>: Character string (with quotes)

Name and path of files to add into the archive, separated by CR characters. These paths can be full paths or paths relative to the current directory. The size of each path must not exceed 260 characters.
The size of each file must not exceed 4 GB. Otherwise, an error occurs.
You cannot use wildcard characters.
Versions 18 and later
This parameter has the following format:

<File path> [ + TAB + <Path to store> ] + RC

If the path to store is specified, the addition will be equivalent to a file addition followed by a call to zipChangePath.
New in version 18
This parameter has the following format:

<File path> [ + TAB + <Path to store> ] + RC

If the path to store is specified, the addition will be equivalent to a file addition followed by a call to zipChangePath.
This parameter has the following format:

<File path> [ + TAB + <Path to store> ] + RC

If the path to store is specified, the addition will be equivalent to a file addition followed by a call to zipChangePath.

<Path section to store>: Optional constant

Versions 18 and later
Indicates the section of file paths that must be stored in the archive. This parameter is taken into account for the files for which <Path to store> was not specified.
zipNone Stores the file name and extension. For example: FileName.pdf
zipDirectory Stores the different directories found in the file path as well as the file name and extension. For example: \Directory\Files\FileName.pdf
zipDrive
(Default value) Store the full and absolute path of file (name of disk, name of directories, file name and file extension). For example: C:\Directory\Files\FileName.pdf
For the ZIP format: This constant has no effect.
For the 7z format: This constant and zipDirectory will have the same effect
If you are using an archive in .CAB format, only the zipNone constant is taken into account. Indeed, the .CAB format cannot be used to store the paths inside the archive.
New in version 18
Indicates the section of file paths that must be stored in the archive. This parameter is taken into account for the files for which <Path to store> was not specified.
zipNone Stores the file name and extension. For example: FileName.pdf
zipDirectory Stores the different directories found in the file path as well as the file name and extension. For example: \Directory\Files\FileName.pdf
zipDrive
(Default value) Store the full and absolute path of file (name of disk, name of directories, file name and file extension). For example: C:\Directory\Files\FileName.pdf
For the ZIP format: This constant has no effect.
For the 7z format: This constant and zipDirectory will have the same effect
If you are using an archive in .CAB format, only the zipNone constant is taken into account. Indeed, the .CAB format cannot be used to store the paths inside the archive.
Indicates the section of file paths that must be stored in the archive. This parameter is taken into account for the files for which <Path to store> was not specified.
zipNone Stores the file name and extension. For example: FileName.pdf
zipDirectory Stores the different directories found in the file path as well as the file name and extension. For example: \Directory\Files\FileName.pdf
zipDrive
(Default value) Store the full and absolute path of file (name of disk, name of directories, file name and file extension). For example: C:\Directory\Files\FileName.pdf
For the ZIP format: This constant has no effect.
For the 7z format: This constant and zipDirectory will have the same effect
If you are using an archive in .CAB format, only the zipNone constant is taken into account. Indeed, the .CAB format cannot be used to store the paths inside the archive.

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
New in version 21
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.

Versions 18 and later

Adding a list of files found in an array Hide the details

<Result> = zipAddFileList(<Archive> , <List of files> [, <Progress bar management>])

<Result>: Integer

0 if the addition was performed,
An error code (value greater than 0) otherwise. For more details on these error codes, see the Remarks.

<Archive>: Character string (with quotes) or zipArchive variable

Name of the archive into which the files will be added.
This name can correspond to:
the name of an archive, defined by zipOpen or zipCreate.
Versions 15 and later
the name of a zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

<List of files>: Array of zipArchivedFile variables

Array of zipArchivedFile variables used to find out the characteristics of the files to add.

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
New in version 21
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.

New in version 18

Adding a list of files found in an array Hide the details

<Result> = zipAddFileList(<Archive> , <List of files> [, <Progress bar management>])

<Result>: Integer

0 if the addition was performed,
An error code (value greater than 0) otherwise. For more details on these error codes, see the Remarks.

<Archive>: Character string (with quotes) or zipArchive variable

Name of the archive into which the files will be added.
This name can correspond to:
the name of an archive, defined by zipOpen or zipCreate.
Versions 15 and later
the name of a zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

<List of files>: Array of zipArchivedFile variables

Array of zipArchivedFile variables used to find out the characteristics of the files to add.

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
New in version 21
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.

Adding a list of files found in an array Hide the details

<Result> = zipAddFileList(<Archive> , <List of files> [, <Progress bar management>])

<Result>: Integer

0 if the addition was performed,
An error code (value greater than 0) otherwise. For more details on these error codes, see the Remarks.

<Archive>: Character string (with quotes) or zipArchive variable

Name of the archive into which the files will be added.
This name can correspond to:
the name of an archive, defined by zipOpen or zipCreate.
Versions 15 and later
the name of a zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

<List of files>: Array of zipArchivedFile variables

Array of zipArchivedFile variables used to find out the characteristics of the files to add.

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
New in version 21
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
Mode for managing the progress bar. This parameter can correspond to:
the name of a WLanguage procedure. This procedure has the following format:

PROCEDURE <Procedure name> (<Current file>,
<Global progress percentage>, <File progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of files being added into the archive.
<File progress percentage> corresponds to the progress percentage of the current file being added into the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the addition of each file.
in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.

Remarks

Use condition

Adding files into an archive can be performed if:

The archive exists (an archive is created by zipCreate).
The archive is accessible in read/write.
The archive is a single-part archive.
The size of the file is less than 4 GB.

Caution:

The full path of each file is stored in the archives in ZIP or WDZ format.
Archives in CAB format: The files must be added immediately after the archive creation. This format cannot be used to add files into an existing archive.
Archives in RAR format: This function is not available.
Archives in 7z format: The archive is entirely compressed whenever zipAddFileList is called.

The maximum number of files that can be included:

in a WDZ file: 232-1.
in a ZIP file: 65535.
in a CAB file: 65535.

Reminder:

Compression level

The files added into an archive in Zip format are compressed by default. The compression level of files added into an archive can be modified by zipCompressionLevel.

Error codes

The following error codes are returned:

1: The path passed in parameter does not exist.
2: Access denied: the user has no sufficient rights or the file is currently used. If the file to insert is a HFSQL data file, it must be closed by the following code:

HClose(<File name>)
Multitask(<Time-out>) // Waits for the effective closing of the file
3: The archive is corrupted.
4: The path does not exist in the archive.
5: Unable to write into the archive.
7: The file is already found in the archive.
8: An archive cannot be added to itself. For example, "MyArchive" cannot be added to "MyArchive".

The message corresponding to the error code is returned by zipMsgError.

Adding a file that is already found in the archive

An error occurs when adding a file that is already found in the archive. A file is identified by its stored path. Therefore, two files with the same name and with the same relative path cannot be added into an archive.

Subscript of files in the archive

When a file is added into an archive, a subscript is automatically assigned to the file. This subscript corresponds to the order in which the files are included in the archive. To select a file in the archive, you can use:

The subscript of the element (note: the subscript of an element is returned by zipFindFile).
The stored path of element.

Progress Bar

In Windows, to view the progress of file addition and compression, an event must be branched on CompressProgressBar (1174). When this message is received:

the _EVE.wParam variable contains the percentage of compression for the current file
the _EVE.lParam variable contains the percentage of compression for all the files.

Caution: This event is not supported if the call to zipAddFileList is performed in a secondary thread.

Versions 21 and later
From version 21, <Progress bar management> can also be used to manage the file addition progress.

New in version 21
From version 21, <Progress bar management> can also be used to manage the file addition progress.

From version 21, <Progress bar management> can also be used to manage the file addition progress.

Component : wd250zip.dll