zipExtractPath (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Example of extracted path

Stored path

Index of files in the archive

See also

zipExtractPath (Function)

In french: zipExtraitChemin

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

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android widget mode.

This function now supports the 7z format.

New in version 18

This function is now available in Android widget mode.

This function now supports the 7z format.

This function is now available in Android widget mode.

This function now supports the 7z format.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

This function now supports the TAR and TGZ (TAR.GZ) formats.

New in version 21

This function is now available in Universal Windows 10 App mode.

This function now supports the TAR and TGZ (TAR.GZ) formats.

This function is now available in Universal Windows 10 App mode.

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
the name of a variable of type zipArchive.
New in version 15
the name of a variable of type zipArchive.
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.

<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:
zipDirectory Returns the different directories of the file (the name and the extension of the file are not returned)
zipDrive Returns the unit name only (WDZ format only). This constant has no effect for the archives whose type differs from WDZ.
This constant is not available. Indeed, there is no root in the paths of directories.
This constant is ignored.
zipExtension Returns the extension of the file (preceded by ".")
zipFilename Returns the name of the file (without its extension)

By default, the extracted path corresponds to the stored path.
This parameter is not available: only the name of the file and its extension are stored and therefore can be extracted.

Remarks

Reminder

Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
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
...

The zipDrive constant is ignored.

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


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.

The zipDrive constant is ignored.

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