ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / Archive functions
  • Reminder
  • Example of extracted path
  • Stored path
  • Index of files in the archive
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Returns the path of a file found in the archive. This archive can be in ZIP, CAB, RAR, WDZ or 7z format.
This path corresponds to the stored path when the file is added into the archive (zipAddFile or zipAddDirectory).
Archive is zipArchive
// Open the archive named "Archive"
ResOpenArchive = zipOpen(Archive, "D:\Backups\Backup.zip")
 
IF ResOpenArchive = 0 THEN
...
// Find the "File.txt" file
ResFileFound = zipFindFile(Archive, "File.txt")
// File path found
ExtractPath = zipExtractPath(Archive, ResFileFound, zipDirectory)
...
END
Syntax
<Result> = zipExtractPath(<Archive> , <File index> [, <Path section to extract>])
<Result>: Character string
Requested path section.
<Archive>: Character string or zipArchive variable
Name of the archive to be used.
This name can correspond to:
<File index>: Integer
Index of file in the archive. zipFindFile returns this index.
<Path section to extract>: Optional constant (or combination of constants)
Section of file path to extract:
zipDirectoryReturns the different directories of the file (the name and the extension of the file are not returned)
zipDriveReturns the unit name only (WDZ format only). This constant has no effect for the archives whose type differs from WDZ.
Linux This constant is not available. Indeed, there is no root in the paths of directories.
zipExtensionReturns the extension of the file (preceded by ".")
zipFilenameReturns the name of the file (without its extension)

By default, the extracted path corresponds to the stored path.
Remarks

Reminder

  • Linux Only ZIP, TAR and TGZ (TAR.GZ) archives are available.

Example of extracted path

If the stored path is "C:\Temp\Data\File.txt", zipExtractPath returns:
  • zipExtension: .txt
  • zipFilename: File
  • zipDirectory: \Temp\Data\
  • zipDrive: C:
  • zipFilename+zipExtension: File.txt
  • zipDirectory+zipFilename: \Temp\Data\File
  • ...
Archives in 7z format: The "\" character (beginning of the path) is not returned.

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 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.

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 index of the element (the index of an element is returned by zipFindFile).
  • the stored path of the element.
Business / UI classification: Business Logic
Component: wd290zip.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 06/12/2023

Send a report | Local help