zipOpen (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Error codes

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).
Versions 18 and later
in 7z format (.7z extension).
New in version 18
in 7z format (.7z extension).
in 7z format (.7z extension).
Versions 21 and later
in TAR format (.TAR extension).
New in version 21
in TAR format (.TAR extension).
in TAR format (.TAR extension).
Versions 21 and later
in TGZ format (.TGZ extension).
New in version 21
in TGZ format (.TGZ extension).
in TGZ format (.TGZ extension).
Versions 21 and later
in TAR.GZ format (.TAR.GZ extension).
New in version 21
in TAR.GZ format (.TAR.GZ extension).
in TAR.GZ format (.TAR.GZ extension).
an executable (.EXE) corresponding to a .WDZ file changed into a self-extracting archive.

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

This function now supports the 7z format.

New in version 18

This function now supports the 7z format.

Versions 21 and later

This function now supports the TAR and TGZ (TAR.GZ) formats.

New in version 21

This function now supports the TAR and TGZ (TAR.GZ) formats.

Example

See additional examples

// Open an archive
ResOpenArchive = zipOpen("MyArchive", "C:\MyArchives\Archive.zip")
// Display an error message if the archive was not opened
IF ResOpenArchive <> 0 THEN
Error(zipMsgError(ResOpenArchive))
END

MyArchive is zipArchive
// Open an archive
ResOpenArchive = zipOpen(MyArchive, "C:\MyArchives\Archive.zip")
// Display an error message if the archive was not opened
IF ResOpenArchive <> 0 THEN
Error(zipMsgError(ResOpenArchive))
END

// Open an archive
ResOpenArchive = zipOpen("MyArchive", "\MyArchives\Archive.zip")
// Display an error message if the archive was not opened
IF ResOpenArchive <> 0 THEN
Error(zipMsgError(ResOpenArchive))
END

MyArchive is zipArchive
// Open an archive
ResOpenArchive = zipOpen(MyArchive, "\MyArchives\Archive.zip")
// Display an error message if the archive was not opened
IF ResOpenArchive <> 0 THEN
Error(zipMsgError(ResOpenArchive))
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. See the Notes for more details.

<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.
The archive is created if it does not exist (except for the "CAB" or "RAR" formats).

<Archive path>: Character string (with quotes)

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)

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

The default opening mode is: zipCreateIfNotFound + zipWrite.

Remarks

Error codes

The following error codes are returned:

1: The path passed in parameter does not exist.
2: Access denied: the user has no sufficient rights.
3: The archive is corrupted.
6: The files of the sub-archives are not arranged in order (when opening a multi-part archive).

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

Reminder: Only the archives in ZIP format are available.

Reminder:

Only the archives in ZIP, TAR and TGZ (TAR.GZ) format are available.
Only the archives in ZIP format are available.

Component : wd0zip.dll