|
- Error codes
- Filter
- Extracted file
- Extraction and password
- Stored path
- Extraction from a multi-part archive on diskettes
zipExtractDirectory (Function) In french: zipExtraitRépertoire Automatically extracts and decompresses files from a directory in the file tree of an archive to a physical location.
Archive is zipArchive
// Ouverture d'une archive
IF zipOpen(Archive, "C:\Archives\Archive.zip") = 0 THEN
// Extraction du répertoire "Temp" à la racine de l'arborescence des fichiers de l'archive
zipExtractDirectory(Archive, "Temp", zipDrive)
END
Syntax
<Result> = zipExtractDirectory(<Archive> , <Directory> [, <Destination> [, <Options> [, <WLanguage procedure> [, <Progress>]]]])
<Result>: entier - 0 if the files have been extracted,
- 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 archive to use.
This name can correspond to:- an archive name, defined by zipOpen or by zipCreate.
 Versions 15 and later         the name of a variable of type zipArchive.  New in version 15 the name of a variable of type zipArchive. Versions 26 and later zipArchive variables are now available. New in version 26 zipArchive variables are now available. zipArchive variables are now available.
<Directory>: Character string (with quotes) Archive file directory to be extracted. This directory can be an absolute path or a path relative to the root of the archive file tree. <Destination>: Optional character string Destination path of extracted files:- Optional character string: The files are extracted into the specified path to which is added the tree structure of the file (the disk is not stored). The specified path is created if it does not exist.
 The path destination of the extracted file must correspond to the working directory of the application (known with the fDataDir function) or to one of its sub-directories. - Optional constant:
| | | zipNone | Extraction into the current directory without restoring the tree structure of the files (if it was stored). | | zipDrive | Extraction:- to the initial location of the files if it was stored and if the drive exists.
- while restoring the tree structure of the files on the current drive if the drive or the stored directory does not exist.
- in the current directory if only the name and extension of the files have been stored.
 This constant is not available. The directories have no root.
This constant and zipDirectory will have the same effect. Archives in 7z format: This constant and zipDirectory will have the same effect. | zipDirectory
(Default value) | Extraction into the current directory without restoring the tree structure of the files (if it was stored). |
<Options>: Optional Integer constant Configure the extraction (if <Destinations> corresponds to a character string):
| | | zipOverwrite | During the extraction, the existing read-only files are automatically overwritten by the extracted files.
|
<WLanguage procedure>: Optional procedure name Name of the WLanguage procedure that will be called if an error occurs when extracting files.
For more details on this procedure, see Parameters of the error handling procedure used by zipExtractDirectory. <Progress>: Control name or procedure name Versions 21 and laterProgress bar management mode. This parameter can correspond to: If you are using an archive: - in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the extraction of each file.
- in CAB and RAR format, the progress bar is refreshed at the end of the extraction of each file.
New in version 21Progress bar management mode. This parameter can correspond to: If you are using an archive: - in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the extraction of each file.
- in CAB and RAR format, the progress bar is refreshed at the end of the extraction of each file.
Progress bar management mode. This parameter can correspond to: If you are using an archive: - in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the extraction of each file.
- in CAB and RAR format, the progress bar is refreshed at the end of the extraction of each file.
Remarks 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.
- 3: The archive is corrupted.
- 4: The path does not exist in the archive.
- 6: The files of the sub-archives are not arranged in order (when extracting from a multi-part archive).
- 21: The specified password is not correct.
The message corresponding to the error code is returned by zipMsgError. Remarks: - Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
- The CAB format is not available.
Filter If a filter has been set on the archive with zipSelectFile, only the files that match the filter will be extracted. Extracted file The extracted files are not deleted from the archive. To delete one file or all the files from the archive, use zipDeleteFile or zipDeleteAll. Stored path The table below presents the paths stored in the archive according to: - the access path to the file,
- the stored path section.
The current directory is: "C:\Temp". | | | | | | zipAddFile | File location | zipNone | zipDirectory | zipDrive | zipAddFile("Archi",
"File.txt") | C:\Temp\File.txt | File.txt | File.txt | File.txt | zipAddFile("Archi",
"Data\File.txt") | C:\Temp\Data\File.txt | File.txt | Data\File.txt | Data\File.txt | zipAddFile("Archi",
"D:\Data\File.txt") | D:\Data\File.txt | File.txt | Data\File.txt | D:\Data\File.txt |
Remark: If the zipDrive constant is used: - the WDZ format stores the full path of the file (including the drive letter).
- the ZIP format does not store the drive letter.
- the 7z format stores the directories only.
This page is also available for…
|
|
|
| |
| Click [Add] to post a comment |
|
| |
|
| |
| |
| |
| |
| |
| |
| | |
| |