<zipArchive variable>.Open (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Archive management functions

Prefix syntax

Open

Presentation

Example

Error codes

Special case of the .GZ extension

See also

<zipArchive variable>.Open (Function)

In french: <Variable zipArchive>.Ouvre

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).
an executable (.EXE) corresponding to a .WDZ file changed into a self-extracting archive.

Example

MyArchive is zipArchive
// Open an archive
ResOpenArchive = MyArchive.Open("C:\MyArchives\Archive.zip")

// Display an error message if the archive was not opened
IF ResOpenArchive <> 0 THEN
Error(zipMsgError(ResOpenArchive))
END

Syntax

<Result> = <Archive>.Open(<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>: zipArchive variable

Name of a variable of type zipArchive corresponding to the archive to use.
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.

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

Archive opening mode:
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.
Archive in TAR or TGZ (TAR.GZ) format: 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: zipCreateIfNotFound + zipWrite.

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

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.

Component: wd270zip.dll