zipAddFileList (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Archive management functions

Prefix syntax

WLanguage procedure

zipAddFileList

Presentation

Example

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.

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>]])

<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 or zipArchive variable

Name of the archive into which the files will be added.
This name can correspond to:
an archive name defined with zipOpen or zipCreate.
the name of a variable of type zipArchive.

<Path of files to add>: Character string

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.
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.
The access path to the file is a full path or a path relative to the working directory of the application (returned by fDataDir). Only the files found in the working directory can be added to the archive.

<Path section to store>: Optional constant

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.
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
This constant is not available as there is no root for the drive.
This constant and zipDirectory will have the same effect.
zipNone Stores the file name and extension. For example: FileName.pdf

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.
This parameter is not available: only the file name and extension are stored.

<Progress>: Control name or procedure name

Progress bar management mode. This parameter can correspond to:
the name of a Progress Bar control found in a window. The progress bar will display the progress regarding the addition and the compression of all the files used.
the name of a WLanguage procedure. For more details on this procedure, see Parameters of the procedure used by zipAddFileList.
If you use a TAR or TGZ (TAR.GZ) archive, the progress bar is refreshed only after the file is added.
The procedure must be a server procedure.
This parameter is not available.

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

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

<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 or zipArchive variable

Name of the archive into which the files will be added.
This name can correspond to:
an archive name defined with zipOpen or zipCreate.
the name of a variable of type zipArchive.

<List of files>: Array of zipArchivedFile variables

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

<Progress>: Control name or procedure name

Progress bar management mode. This parameter can correspond to:
the name of a Progress Bar control found in a window. The progress bar will display the progress regarding the addition and the compression of all the files used.
the name of a WLanguage procedure. For more details on this procedure, see Parameters of the procedure used by zipAddFileList.
If you use a TAR or TGZ (TAR.GZ) archive, the progress bar is refreshed only after the file is added.
The procedure must be a server procedure.

Remarks

Use condition

Adding files into an archive can be performed if:

The archive exists (archives are created using 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:

Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
Only ZIP archives are available.
The CAB format is not available.

Compression level

The files added into a zip archive 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 as 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 an HFSQL data file, it must be closed by the following code:

HClose(<File name>)
Multitask(<Timeout>) // 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.

Index of files in the archive

When a file is added into an archive, an index is automatically assigned to the file. This index 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 index of an element is returned by zipFindFile).
The stored path of element.

Business / UI classification: Business Logic

Component: wd280zip.dll