<zipArchive variable>.ListFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Reminder
Number of files in an archive
Stored path

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<zipArchive variable>.ListFile (Function)

In french: <Variable zipArchive>.ListeFichier

Returns the list of files found in an archive.

Versions 18 and later

This function now supports the 7z format.

New in version 18

This function now supports the 7z format.

Versions 21 and later

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

New in version 21

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

Example

MyArchive is zipArchive
// Open an archive
ResOpenArchive = MyArchive.Open("C:\Temp\MyArchive.ZIP")
IF ResOpenArchive = 0 THEN
...
// Return the list of files found in the archive
AListOfFiles = MyArchive.ListFile()
// Display files in a List Box control
LIST_ZipFile.Add(AListOfFiles)
...
END

Syntax

<Result> = <Archive>.ListFile()

<Result>: Character string

List of files found in the archive. This list is using the following format:

<Stored path> + CR + <Stored path 2> + CR +...

<Stored path> corresponds to the file name and path (if the file path was stored when the file was added into the archive).

<Archive>: zipArchive variable

Name of a zipArchive variable that corresponds to the archive to use.

Remarks

Reminder

Only the archives in ZIP, TAR and TGZ (TAR.GZ) format are available.
Only the archives in ZIP format are available.

Number of files in an archive

The number of files found in an archive is returned by zipNbFile.

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) while the ZIP format does not store the drive letter.

The table below presents the paths stored in the archive according to:

the access path to the file,
the stored path section.


zipAddFile	File location	zipNone	zipDirectory
zipAddFile("Archi", "\File.txt")	\File.txt	File.txt	File.txt
zipAddFile("Archi", "\Temp\File.txt")	\Temp\File.txt	File.txt	Temp\File.txt

Component: wd260zip.dll