zipExtractAll (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Extraction on diskettes from a multi-part archive

See also

zipExtractAll (Function)

In french: zipExtraitTout

Extracts all files from an archive and decompresses them.

The archive used can be in CAB, RAR, ZIP, WDZ, 7z, TAR or TGZ (TAR.GZ) format.

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

See additional examples

Archive is zipArchive

// Open an archive
ResOpenArchive = zipOpen(Archive, "C:\Archives\Archive.zip")

IF ResOpenArchive = 0 THEN
...
// Extract all files from the archive
ResExtractAll = zipExtractAll(Archive, zipDrive)
...
END

Syntax

<Result> = zipExtractAll(<Archive> [, <Destination of files> [, <Options>] [, <WLanguage procedure>] , [ <Progress bar management>]])

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

<Destination of files>: 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 each 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 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.
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.

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.
zipOverwrite During the extraction, the existing read-only files are automatically overwritten by the extracted files. This constant can be combined with the zipDrive and zipDirectory constants.
This constant is not available.

These constants cannot be used.

<Options>: Optional constant

Configure the extraction (if <Destination of files> 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

Versions 19 and later
Name of the WLanguage procedure that will be called if an error occurs when extracting files.
CAUTION: This parameter can be used only if <Archive> corresponds to a zipArchive variable.
This procedure has the following format:

PROCEDURE <Procedure name>(<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 zipExtractAll.
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.
New in version 19
Name of the WLanguage procedure that will be called if an error occurs when extracting files.
CAUTION: This parameter can be used only if <Archive> corresponds to a zipArchive variable.
This procedure has the following format:

PROCEDURE <Procedure name>(<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 zipExtractAll.
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.
Name of the WLanguage procedure that will be called if an error occurs when extracting files.
CAUTION: This parameter can be used only if <Archive> corresponds to a zipArchive variable.
This procedure has the following format:

PROCEDURE <Procedure name>(<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 zipExtractAll.
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

Versions 21 and later
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 <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.
New in version 21
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 <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.
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 <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).

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 files are not deleted from the archive. To delete one file or all the files from the archive, use zipDeleteFile or zipDeleteAll.

Extraction on diskettes from a multi-part archive

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