|
- Use conditions
- Compression level
- Error codes
- Adding a file that is already found in the archive
- Subscript of files in the archive
- Progress Bar
zipAddDirectory (Function) In french: zipAjouteRépertoire Syntax
Adding the directory files while specifying the path to store Hide the details
<Result> = zipAddDirectory(<Archive> , <Directory path> [, <Subdirectory> [, <Path section to store> [, <WLanguage procedure> [, <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 content of the directory must be added.
This name can correspond to: <Directory path>: Character string (with quotes) Path of directory that will be added into the archive (up to 260 characters). This path can be a full path or a path relative to the current directory. The function returns an error if this parameter corresponds to an empty string ("").
The size of the files found in this directory must be less than 4 GB. Otherwise, an error occurs.
<Subdirectory>: Optional boolean - True (default value) if the sub-directories must be added,
- False if the sub-directories must not be added.
<Path section to store>: Optional constant Path section to store for each file in the archive: | | | zipDrive | 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 WDZ format: The full path of file (including the drive letter) is stored.
For the ZIP format: The drive letter is not stored.
For the 7z format: This constant and zipDirectory will have the same effect.
| | zipRelative | The path passed in parameter is considered as being the root of the archive. The stored path for all files and sub-directories is given in relation to this root.
Therefore, if the added directory is: "C:\Temp\Doc" containing the following elements:- the Test1.doc file,
- the Test2.doc file is found in the SYS sub-directory,
the stored information will be relative to the "C:\Temp\Doc" directory:- Test1.doc,
- SYS\Test2.Doc.
| zipDirectory
(Default value) | Stores the different directories found in the file path as well as the file name and extension. For example: \Directory\Files\FileName.pdf |
Archive in .CAB format: None of these constants is taken into account. Indeed, the .CAB format cannot be used to store the paths inside the archive.
<WLanguage procedure>: Optional procedure name Name of WLanguage procedure that will be called before adding each file. This procedure allows you to archive a tree structure while omitting one or more files. This procedure must have the following format:
PROCEDURE ProcedureName (<File name>)
where <File name> is a character string that contains the path of the file that will be processed by zipAddDirectory.
If the procedure returns True, the file must be included in the archive.
If the procedure returns False, the file must not be included in the archive.
<Progress bar management>: Character string (with or without quotes)  Versions 21 and laterMode for managing the progress bar. This parameter can correspond to:   the name of a Progress Bar control found in a window. The progress bar will display the addition and compression progress of the file being managed. - the name of a WLanguage procedure. This procedure has the following format:
<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 21Mode for managing the progress bar. This parameter can correspond to: - the name of a Progress Bar control found in a window. The progress bar will display the addition and compression progress of the file being managed.
- the name of a WLanguage procedure. This procedure has the following format:
<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.
- the name of a Progress Bar control found in a window. The progress bar will display the addition and compression progress of the file being managed.
- the name of a WLanguage procedure. This procedure has the following format:
<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 the files found in a directory while specifying the path to ignore Hide the details
<Result> = zipAddDirectory(<Archive> , <Directory path> [, <Subdirectory> [, <Path section to ignore> [, <WLanguage procedure> [, <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 content of the directory must be added.
This name can correspond to: <Directory path>: Character string (with quotes) Path of directory that will be added into the archive (up to 260 characters). This path can be a full path or a path relative to the current directory.
The function returns an error if this parameter corresponds to an empty string ("").
The size of the files found in this directory must be less than 4 GB. Otherwise, an error occurs
<Subdirectory>: Optional boolean - True (default value) if the sub-directories must be added,
- False if the sub-directories must not be added.
<Path section to ignore>: Optional character string (with quotes) Indicates the section of file path that must not be stored in the archive. For example, if the full path of the directory added into the archive is: "C:\My Documents\Work\" and if <Section of path to ignore> is set to "C:\My Documents\", on the "Work\" section will be stored. <WLanguage procedure>: Optional procedure name Name of WLanguage procedure that will be called before adding each file. This procedure allows you to archive a tree structure while omitting one or more files. This procedure must have the following format:
PROCEDURE ProcedureName (<File name>)
where <File name> is a character string that contains the path of the file that will be processed by zipAddDirectory.
If the procedure returns True, the file is included in the archive.
If the procedure returns False, the file is not included in the archive.
<Progress bar management>: Character string (with or without quotes) Versions 21 and laterMode for managing the progress bar. This parameter can correspond to: - the name of a Progress Bar control found in a window. The progress bar will display the addition and compression progress of the file being managed.
- the name of a WLanguage procedure. This procedure has the following format:
<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 before and after 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 21Mode for managing the progress bar. This parameter can correspond to: - the name of a Progress Bar control found in a window. The progress bar will display the addition and compression progress of the file being managed.
- the name of a WLanguage procedure. This procedure has the following format:
<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 before and after 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 Progress Bar control found in a window. The progress bar will display the addition and compression progress of the file being managed.
- the name of a WLanguage procedure. This procedure has the following format:
<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 before and after the addition of each file.
- in 7z format, only <Global progress percentage> is specified. <File progress percentage> will have the same value.
Remarks Use conditions 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: - 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 zipAddDirectory 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.
Remark: If the zipHeader64 constant is used when creating the archive ( zipCreate), you will have the ability to create archives exceeding 4 GB.
Reminder:  Only the archives in ZIP, TAR and TGZ (TAR.GZ) format are available.  Only the archives in ZIP format are available.
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.
- 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.
Business / UI classification : Business Logic
This page is also available for…
|
|
|
| |
| Click [Add] to post a comment |
|
| |
|
| |
| |
| |
| |
| |
| |
| | |
| |