zipExtractFile (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

zipExtractFile

Presentation

Example

Error codes

Extracted file

Extraction and password

Index of files in the archive

Stored path

Extraction from a multi-part archive on diskettes

See also

zipExtractFile (Function)

In french: zipExtraitFichier

Extracts a file from an archive and automatically decompresses it to a physical location or in memory.

Example

See additional examples

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 = zipExtractFile(Archive, "File.txt", zipDrive)
...
END

Syntax

Extracting a file identified by its index Hide the details

<Result> = zipExtractFile(<Archive> , <File index> [, <File destination> [, <Progress>]])

<Result>: Integer or buffer

0 if the file was extracted,
An error code (value greater than 0) otherwise. For more details on these error codes, see the Remarks.
When extracting "in memory", corresponds to the buffer containing the extracted file.

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

<File index>: Integer

Index of file to extract from the archive. zipFindFile returns this index.

<File destination>: Optional character string or constant

Destination path of extracted file:
Optional character string: The file is extracted into the specified path to which is added the stored tree structure of file (the drive 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 while restoring the tree structure of file (if it was stored).
zipDrive Extraction:
to the initial file location if it was stored and if the drive exists.
while restoring the tree structure of the file on the current drive if the drive or the stored directory does not exist.
into the current directory if only the file name and extension 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.
zipInMemory Extracts the file in memory. The file content is directly returned by the function. It can be assigned to a Buffer variable for example.
This feature is available for ZIP and WDZ archives only.
zipNone Extraction into the current directory without restoring the tree structure of file (if it was stored).

These constants cannot be used.

<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 of file extraction.
the name of a WLanguage procedure. This procedure has the following format:

<Procedure name> (<Current file>, <Progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Progress percentage> corresponds to the progress percentage of the file being extracted from the archive.
Caution: The progress bar is refreshed at the end of file extraction for the following types of archives:
TAR or TGZ (TAR.GZ),
RAR,
CAB.

Extracting a file identified by its path Hide the details

<Result> = zipExtractFile(<Archive> , <File path> [, <File destination> [, <Progress>]])

<Result>: Integer or buffer

0 if the file was extracted,
An error code (value greater than 0) otherwise. For more details on these error codes, see the Remarks.
When extracting "in memory", corresponds to the buffer containing the extracted file.

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

<File path>: Character string

Stored path of file to extract from the archive. Performs an exact-match search on the path of file in the archive.

<File destination>: Optional character string or constant

Destination path of extracted file:
Optional character string: The file is extracted into the specified path to which is added the stored tree structure of file (the drive 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 while restoring the tree structure of file (if it was stored).
zipDrive Extraction:
to the initial file location if it was stored and if the drive exists.
while restoring the tree structure of the file on the current drive if the drive or the stored directory does not exist.
into the current directory if only the file name and extension 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.
zipInMemory Extracts the file in memory. The file content is directly returned by the function. It can be assigned to a Buffer variable for example.
This feature is available for ZIP and WDZ archives only.
zipNone Extraction into the current directory without restoring the tree structure of file (if it was stored).

These constants cannot be used.

<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 of file extraction.
the name of a WLanguage procedure. This procedure has the following format:

<Procedure name> (<Current file>, <Progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Progress percentage> corresponds to the progress percentage of the file being extracted from the archive.
Caution: The progress bar is refreshed at the end of file extraction for the following types of archives:
TAR or TGZ (TAR.GZ),
RAR,
CAB.

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

Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
Only ZIP archives are available.
RAR is supported up to and including version 4.

Extracted file

The extracted file is 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.

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.

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. To extract several files from a multi-part archive, we advise you to extract the files according to the order of their index in the archive. Therefore, the different diskettes will be requested in ascending order.

Business / UI classification: Business Logic

Component: wd270zip.dll