PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Error codes
  • Special case of the .GZ extension
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
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 18 and later
WEBDEV - Server codeWindows This function now supports the 7z format.
New in version 18
WEBDEV - Server codeWindows This function now supports the 7z format.
WEBDEV - Server codeWindows This function now supports the 7z format.
Versions 21 and later
WEBDEV - Server codeWindowsLinux This function now supports the TAR and TGZ (TAR.GZ) formats.
New in version 21
WEBDEV - Server codeWindowsLinux This function now supports the TAR and TGZ (TAR.GZ) formats.
WEBDEV - Server codeWindowsLinux This function now supports the TAR and TGZ (TAR.GZ) formats.
Example
WEBDEV - Server codeAjax
MyArchive is zipArchive
// Open an archive
ResOpenArchive = MyArchive.Open("C:\MyArchives\Archive.zip")
// In Windows Mobile
// ResOpenArchive = MyArchive.Open("\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 zipArchive variable that corresponds 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 (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.
<Opening mode>: Optional constant (or combination of constants)
Archive opening mode:
zipCreateIfNotFoundCreates the archive if it does not exist
(not available for .CAB and .RAR files)
zipWriteOpening in read/write
(not available for .CAB and .RAR files)
zipHeader64Allows you to create an archive exceeding 4 GB on which zipChangePath can be used.
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.
zipReadOpening in read-only

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:
  • Linux Only ZIP, TAR and TGZ (TAR.GZ) 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.
Component: wd260zip.dll
Minimum version required
  • Version 24
This page is also available for…
Comments
Click [Add] to post a comment