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

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.

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:
  

  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.
  zipDirectory	Extraction into the current directory while restoring the tree structure of file (if it was stored).
  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 because the notion of current directory is not supported by the Pocket PC.

These constants cannot be used.

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.

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.

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.