zipOpen (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Archive functions

Error codes
Special case of the .GZ extension

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

zipOpen (Function)

In french: zipOuvre

Opens an existing archive.

For the archives in "CAB" or "RAR" format, the archive is created if it does not exist.

The archive can be:

in WinZip or PKZip format (.ZIP extension).
in WINDEV format (.WDZ extension).
in Cabinet file format (.CAB extension).
in RAR format (.RAR extension).
in 7z format (.7z extension).
in TAR format (.TAR extension).
in TGZ format (.TGZ extension).
in TAR.GZ format (.TAR.GZ extension).
New in version 2025
in gzip format (extension ;gz).
an executable (.EXE) corresponding to a .WDZ file changed into a self-extracting archive.

New in version 2025

The gzip format (.gz extension) is now supported.

Example

See additional examples

MonArchive is zipArchive
// Ouverture d'une archive
ResOuvreArchive = zipOpen(MonArchive, "C:\MesArchives\Archive.zip")

// Affichage du message d'erreur si l'archive n'a pas été ouverte
IF ResOuvreArchive <> 0 THEN
	Error(zipMsgError(ResOuvreArchive))
END

Syntax

<Result> = zipOpen(<Archive> , <Archive path> [, <Opening mode>])

<Result>: Integer

0 if the archive was opened,
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:
an archive name defined with zipOpen or zipCreate.
the name of a variable of type zipArchive.
zipArchive variables are not available in Java.
The archive is created if it does not exist (except for the "CAB" or "RAR" formats).

<Archive path>: Character string

Path and name of archive (up to 260 characters). The archive extension can be specified. If the archive extension is not specified, the default extension is .WDZ.
If the extension is not specified, the extension will be ".ZIP".

<Opening mode>: Optional constant (or combination of constants)

Mode for opening the archive:
zipCreateIfNotFound Creates the archive if it does not exist
(not available for .CAB and .RAR files)
zipHeader64 Allows you to create an archive larger than 4 GB on which zipChangePath can be used.
This constant is not available.
Archive in TAR or TGZ format (TAR.GZ): This constant is not available.
zipRead Opening in read-only
zipWrite Opening in read/write
(not available for .CAB and .RAR files)

The default opening mode is: zipCreationIfNonexistent + zipWrite.

Remarks

Error codes

The following error codes are returned:

1: Path passed as parameter does not exist.
2: Access denied: user does not have sufficient rights.
3: The archive is corrupt.
6: The files in the sub-archives are not in the right order (this is the case when opening a multi-part archive).

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

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

Special case of the .GZ extension

'.tar.gz' files generated by GitHub should not be confused with compressed '.gz' files.
Content compressed in gzip format can be decompressed with Uncompress.

Business / UI classification: Business Logic

Component: wd300zip.dll