PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • 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).
Versions 15 and later
Android This function is now available for Android applications.
New in version 15
Android This function is now available for Android applications.
Android This function is now available for Android applications.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Versions 18 and later
Android Widget This function is now available in Android widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
New in version 18
Android Widget This function is now available in Android widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
Android Widget This function is now available in Android widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
WINDEVWEBDEV - Server codeWindowsLinuxUniversal Windows 10 AppiPhone/iPad This function now supports the TAR and TGZ (TAR.GZ) formats.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
WINDEVWEBDEV - Server codeWindowsLinuxUniversal Windows 10 AppiPhone/iPad This function now supports the TAR and TGZ (TAR.GZ) formats.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
WINDEVWEBDEV - Server codeWindowsLinuxUniversal Windows 10 AppiPhone/iPad This function now supports the TAR and TGZ (TAR.GZ) formats.
Example
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:
  • the name of an archive, defined by zipOpen or zipCreate.
  • Versions 15 and later
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    New in version 15
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    Versions 26 and later
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    New in version 26
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
<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.
LinuxiPhone/iPadIOS WidgetMac Catalyst This constant is not available. Indeed, there is no root in the paths of directories.
AndroidAndroid Widget Java This constant is ignored.
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.
Universal Windows 10 App This parameter is not available: only the name of the file and its extension are stored and therefore can be extracted.
Remarks

Reminder

  • LinuxUniversal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
  • AndroidAndroid Widget Java Only ZIP 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
  • ...
AndroidAndroid Widget Java The zipDrive constant is ignored.
Universal Windows 10 App Only the name of the file and its extension can be extracted.
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.
Java The zipDrive constant is ignored.
Universal Windows 10 App The directory and the disk are not stored in the archive path. Only the file name and extension are stored.

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 element.
Business / UI classification: Business Logic
Component: wd270zip.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment