ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage functions / Standard functions / Archive functions
  • Error codes
  • Filter
  • Extracted file
  • Extraction and password
  • Stored path
  • Extraction from a multi-part archive on diskettes
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Automatically extracts and decompresses files from a directory in the file tree of an archive to a physical location.
Example
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>: Integer
  • 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 the archive to be used.
This name can correspond to:
<Directory>: Character string
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: Files are extracted to the specified path, to which the file's memorized tree structure is added (the disk is not preserved). The specified path is created if it does not exist.
  • Optional constant:
    zipDirectory
    (Default value)
    Extraction into the current directory without restoring the tree structure of the files (if it was stored).
    zipDriveExtraction:
    • 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.
    LinuxiPhone/iPadIOS WidgetMac Catalyst This constant is not available. The directories have no root.
    AndroidAndroid Widget This constant and zipDirectory will have the same effect.
    Archives in format 7z: This constant will have the same effect as the constant zipDirectory.
    zipNoneExtraction 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):
zipOverwriteDuring the extraction, the existing read-only files are automatically overwritten by the extracted files.
AndroidAndroid Widget This constant is not available.
<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.
WEBDEV - Server code This procedure must be a server procedure.
<Progress>: Control name or procedure name
Progress bar management mode. This parameter can correspond to:
If you handle an:
  • in TAR, gzip or TGZ (TAR.GZ) formatProgressBar is updated only when each file has been extracted.
  • in CAB and RAR format, the progress bar is refreshed at the end of the extraction of each file.
WEBDEV - Server code The procedure must be a server procedure.
Remarks

Error codes

The following error codes are returned:
  • 1: Path passed as parameter does not exist.
  • 2: Access denied: user does not have sufficient rights.
  • 3: The archive is corrupt.
  • 4: The path does not exist in the archive.
  • 6: Sub-archive files are not in order (case of extraction from a multi-part archive).
  • 21: The password specified is not correct.
The message corresponding to the error code is returned by zipMsgError.
Remarks:
  • LinuxiPhone/iPadIOS WidgetMac Catalyst Only archives in ZIP, TAR, gzip and TGZ (TAR.GZ) formats are available.
  • AndroidAndroid Widget The CAB format is not available.
  • RAR is supported up to and including version 5.

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.
WINDEVWEBDEV - Server codeReports and QueriesiPhone/iPadIOS WidgetMac CatalystUser code (UMC)Ajax

Extraction and password

If the file is not encrypted and if zipPassword was used:
  • Archive in WDZ format: The file is still extracted.
  • Archive in ZIP format: An error appears.

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".
zipAddFileFile locationzipNonezipDirectoryzipDrive
zipAddFile("Archi",
"File.txt")
C:\Temp\File.txtFile.txtFile.txtFile.txt
zipAddFile("Archi",
"Data\File.txt")
C:\Temp\Data\File.txtFile.txtData\File.txtData\File.txt
zipAddFile("Archi",
"D:\Data\File.txt")
D:\Data\File.txtFile.txtData\File.txtD:\Data\File.txt


Remark: If the constant zipDisk 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.
AndroidAndroid Widget The zipDrive constant is equivalent to the zipDirectory constant.
WINDEVWEBDEV - Server codeReports and QueriesUser code (UMC)Ajax

Extraction from a multi-part archive on diskettes

If the files to extract are found on different diskettes, the corresponding diskette is automatically requested.
Component: wd300zip.dll
Minimum version required
  • Version 26
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 03/27/2025

Send a report | Local help