|
- Use condition
- Compression level
- Error codes
- Adding a file that is already found in the archive
- Index of files in the archive
zipAddFileList (Function) In french: zipAjouteListeFichier
 Not available
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: <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.
 Versions 18 and later New in version 18 <Path section to store>: Optional constant Versions 18 and laterIndicates 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 | | 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. New in version 18Indicates 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 | | 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. 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 | | 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.
<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. Versions 18 and later New in version 18 Remarks 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
This page is also available for…
|
|
|
| |
| Click [Add] to post a comment |
|
| |
|
| |
| |
| |
| |
| |
| |
| | |
| |