zipOpenCAB (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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

zipOpenCAB (Function)

In french: zipOuvreCAB

Opens an existing archive in CAB format.

Example

See additional examples

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

// Affichage du message d'erreur si l'archive n'a pas été ouverte
IF ResOuvreArchive <> 0 THEN
	Error(zipMsgError(ResOuvreArchive))
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.
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: 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.

Component: wd300zip.dll