zipExtractFileList (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Archive management functions

Prefix syntax

WLanguage procedure

zipExtractFileList

Presentation

Example

Error codes

Extracted file

Extraction and password

Stored path

Extraction from a multi-part archive on diskettes

See also

zipExtractFileList (Function)

In french: zipExtraitListeFichier

Not available

Extracts and decompresses a list of files found in an archive to a physical location.

Example

Archive is zipArchive
// Open an archive
ResOpenArchive = zipOpen(Archive, "C:\Archives\Archive.zip")
IF ResOpenArchive = 0 THEN
...
// Extract a file to its initial location
ResExtractFile = zipExtractFileList(Archive, "\Temp\File.doc" + ...
CR + "\Temp\File2.doc", zipDrive)
...
END

Syntax

<Result> = zipExtractFileList(<Archive> , <List of paths> [, <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:
the name of an archive, defined by zipOpen or zipCreate.
the name of a variable of type zipArchive.

<List of paths>: Character string

List of stored paths of files that will be extracted from the archive. The different paths are separated by CR characters (Carriage Return).
Performs an exact-match search on each path of files found in the archive.

<Destination>: Optional character string or constant

Destination path of extracted files:
Optional character string: The files are extracted into the specified path to which is added the tree structure of the file (the disk is not stored). The specified path is created if it does not exist.
The destination path of the extracted file must correspond to the working directory of the application (returned by fDataDir) or one of its subdirectories.
Optional constant:
zipDirectory
(Default value) Extraction into the current directory without restoring the tree structure of the files (if it was stored).
zipDrive Extraction:
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.
This constant is not available. The directories have no root.
This constant and zipDirectory will have the same effect. Archives in 7z format: This constant and zipDirectory will have the same effect.
zipNone Extraction into the current directory without restoring the tree structure of the files (if it was stored).
These constants cannot be used.

<Options>: Optional Integer constant

Configure the extraction (if <Destinations> corresponds to a character string):
zipOverwrite During the extraction, the existing read-only files are automatically overwritten by the extracted files.
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. This procedure has the following format:

PROCEDURE ProcedureName (<Error Code>, <File Name>)

where:
<Error code> is an integer corresponding to the code of the error that occurred when extracting the file.
<File name> is a character string that contains the path of the file processed by zipExtractFileList.
The procedure can return one of the following constants:
zipCancel Cancels the extraction of files from the archive.
zipIgnore Ignores the file in error.
zipRetry Retries the file extraction.
This procedure must be a server procedure.
This parameter is not allowed.

<Progress>: Control name or procedure name

Progress bar management mode. This parameter can correspond to:
the name of a Progress Bar control found in a window. The progress bar will display the progress regarding the extraction of all the files used.
the name of a WLanguage procedure. This procedure has the following format:

<Procedure name> (<Current file>, <Global progress percentage>,
<File progress percentage >)

where:
<Current file> corresponds to the name of the file currently processed.
<Global progress percentage> corresponds to the progress percentage of the extraction of files from the archive.
<File progress percentage> corresponds to the progress percentage of the file being extracted from the archive.
If you are using an archive:
in TAR or TGZ (TAR.GZ) format, the progress bar is refreshed at the end of the extraction of each file.
in CAB and RAR format, the progress bar is refreshed at the end of the extraction of each file.
in 7z format, only <Overall progress percentage> is specified. <File progress percentage> will have the same value.
The procedure must be a server procedure.

Remarks

Error codes

The following error codes are returned:

1: The path passed as parameter does not exist.
2: Access denied: the user has no sufficient rights.
3: The archive is corrupted.
4: The path does not exist in the archive.
6: The files of the sub-archives are not arranged in order (when extracting from a multi-part archive).
21: The specified password is not correct.

The message corresponding to the error code is returned by zipMsgError.

Remarks:

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

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.

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

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 equivalent to the zipDirectory constant.

The directory and the disk are not stored in the archive path. Only the file name and extension are stored.

Extraction from a multi-part archive on diskettes

If the files to extract are found on different diskettes, the corresponding diskette is automatically requested.

Business / UI classification: Business Logic

Component: wd270zip.dll