zipOpenCAB (Function)

Help

WLanguage

WLanguage functions

Standard functions

Archive management functions

Archiving functions (management of ZIP, WDZ, CAB, RAR, 7z, TAR and TGZ (TAR.GZ))

Constants for the archiving functions

The archives

The single-part and multi-part archives

zipAddDirectory (Example)

zipChangePath (Example)

zipCreateExe (Example)

zipCreateExe

zipCurrentFile (Example)

zipCurrentFile

zipDeleteAll (Example)

zipDeleteAll

zipDeleteFile (Example)

zipDeleteFile

zipDeleteFileList

zipExist

zipExtractAll (Example)

zipExtractAll

zipExtractDirectory

zipExtractFile (Example)

zipExtractFile

zipExtractFileList

zipExtractPath (Example)

zipExtractPath

zipFileSize (Example)

zipFileSize

zipFilter

zipFindFile (Example)

zipFindFile

zipInfoFile (Example)

zipInfoFile

zipIsMulti (Example)

zipIsMulti

zipListFile (Example)

zipListFile

zipMerge (Example)

zipMerge

zipMsgError (Example)

zipNbPartNeeded (Example)

Error codes

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

zipOpenCAB (Function)

In french: zipOuvreCAB

Opens an existing archive in CAB format.

Example

See additional examples

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

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

Syntax

<Result> = zipOpenCAB(<Archive> , <Archive path> [, <Archive 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:
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.

<Archive path>: Character string

Path and name of archive (up to 260 characters). The archive extension can be specified.

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

Options for opening the archive:
zipHeader64 Allows you to create an archive larger than 4 GB on which zipChangePath can be used.
zipRead Opening in read-only.

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.

Component: wd270zip.dll