zipExtractFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Extraction and password

Subscript of files in the archive

Stored path

Extraction from a multi-part archive on diskettes

Progress Bar

See also

zipExtractFile (Function)

In french: zipExtraitFichier

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

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 19 and later

This function is now available in Windows Store apps mode.

New in version 19

This function is now available in Windows Store apps mode.

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

See additional examples

Archive is zipArchive
// Open an archive
ResOpenArchive = zipOpen(Archive, "C:\Archives\Archive.zip")
// In Windows Mobile:
// ResOpenArchive = zipOpen(Archive, "\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 subscript Hide the details

<Result> = zipExtractFile(<Archive> , <File subscript> [, <File destination> [, <Progress bar management>]])

<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 (with quotes) or zipArchive variable

Name of archive to use.
This name can correspond to:
an archive name, defined by zipOpen or by zipCreate.
Versions 15 and later
the name of a zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

<File subscript>: Integer

Subscript of file to extract from the archive. This subscript is returned by zipFindFile.

<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:
zipNone Extraction into the current directory without 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.
zipDirectory
(Default value) Extraction into the current directory while restoring the tree structure of file (if it was stored).

These constants cannot be used because the notion of current directory is not supported by the Pocket PC.
These constants cannot be used.

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Mode for managing the progress bar. 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.
New in version 21
Mode for managing the progress bar. 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.
Mode for managing the progress bar. 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 bar management>]])

<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 (with quotes) or zipArchive variable

Name of archive to use.
This name can correspond to:
the name of an archive, defined by zipOpen or zipCreate.
Versions 15 and later
the name of a zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

<File path>: Character string (with quotes)

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:
zipNone Extraction into the current directory without 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.
zipDirectory
(Default value) Extraction into the current directory while restoring the tree structure of file (if it was stored).

These constants cannot be used because the notion of current directory is not supported by the Pocket PC.
These constants cannot be used.

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Mode for managing the progress bar. 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.
New in version 21
Mode for managing the progress bar. 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.
Mode for managing the progress bar. 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 the archives in ZIP, TAR and TGZ (TAR.GZ) format are available.
Only the archives in ZIP format are available.

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.

Subscript of files in the archive

When a file is added into an archive, a subscript is automatically assigned to the file. This subscript corresponds to the order in which the files are included in the archive. To select a file in the archive, you can use:

the subscript of the element (the subscript 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.

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

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 subscript in the archive. Therefore, the different diskettes will be requested in ascending order.

Progress Bar

In Windows, to view the progress of file extraction and decompression, an event must be branched on CompressGauge (1174).
When this message is received, the _EVE.wParam variable contains the percentage of file already decompressed.

Versions 21 and later
From version 21, <Progress bar management> can also be used to manage the file addition progress.

New in version 21
From version 21, <Progress bar management> can also be used to manage the file addition progress.

From version 21, <Progress bar management> can also be used to manage the file addition progress.

Business / UI classification : Business Logic

Component : wd260zip.dll