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/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
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 15 and later
Android This function is now available for Android applications.
New in version 15
Android This function is now available for Android applications.
Android This function is now available for Android applications.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Versions 18 and later
Android Widget This function is now available in Android widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
New in version 18
Android Widget This function is now available in Android widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
Android Widget This function is now available in Android widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
WINDEVWEBDEV - Server codeWindowsLinuxUniversal Windows 10 AppiPhone/iPad This function now supports the TAR and TGZ (TAR.GZ) formats.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
WINDEVWEBDEV - Server codeWindowsLinuxUniversal Windows 10 AppiPhone/iPad This function now supports the TAR and TGZ (TAR.GZ) formats.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
WINDEVWEBDEV - Server codeWindowsLinuxUniversal Windows 10 AppiPhone/iPad This function now supports the TAR and TGZ (TAR.GZ) formats.
WINDEVWEBDEV - Server codeReports and QueriesUser code (UMC)Ajax
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
Syntax
<Result> = zipOpen(<Archive> , <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>: 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
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    New in version 15
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    Versions 26 and later
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    New in version 26
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
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.
AndroidAndroid Widget Java If the extension is not specified, the extension will be ".ZIP".
Universal Windows 10 App The archive path is a full path or a path relative to the working directory of the application (returned by fDataDir).
<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)
zipHeader64Allows you to create an archive larger than 4 GB on which zipChangePath can be used.
AndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystJava 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.
zipReadOpening in read-only
zipWriteOpening in read/write
(not available for .CAB and .RAR files)

The default opening mode is: zipCreateIfNotFound + zipWrite.
Universal Windows 10 App This parameter is not available: the opening mode used corresponds to 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:
  • LinuxUniversal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
  • AndroidAndroid Widget Java Only ZIP 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.
Business / UI classification: Business Logic
Component: wd270zip.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment