zipArchive (Variable type)

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

Properties specific to zipArchive variables
Functions that use zipArchive variables:

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

zipArchive (Variable type)

In french: zipArchive

The zipArchive type is used to manipulate an archive file corresponding to one of the following formats: ZIP, CAB, RAR, WDZ, 7z, TAR, gzip or TGZ (TAR.GZ).. You can define and change the characteristics of this file using different WLanguage properties.

The CAB format is not available.

Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

New in version 2025

The gzip format (.gz extension) is now supported.

Example

// Réalisation d'une archive de sauvegarde du répertoire "Mes Documents"
MonArchive is zipArchive
// Protection de l'archive par un mot de passe
MonArchive.Password = "secret"
// Création de l'archive
zipCreate(MonArchive, "s:\Sauvegardes\" + DateToString(DateSys(), "AAAA-MM-JJ") + ".zip")
// Ajout des fichiers
zipAddDirectory(MonArchive, SysDir(srMyDocuments))
// Fermeture de l'archive
zipClose(MonArchive)

Properties

Properties specific to zipArchive variables

The following properties can be used to handle zipArchive variables:

Name	Type used	Effect

ArchiveFormat	Integer constant	Format of the archive file: zipFormatCAB: File in CAB format. zipFormatRAR: File in RAR format. zipFormatWDZ: File in WDZ format. zipFormatZIP: File in ZIP format. zipFormat7Z: File in 7z format. zipFormatTAR: File in TAR format. zipFormatTARGZ: File in TGZ (TAR.GZ) or gzip format.
CompressedSize	8-byte integer	Total compressed size of the files found in the archive. This property is read-only.
CompressionLevel	entier	Compression level that must be used to add files into the archive. For more details, see zipCompressionLevel.
File	Array of zipArchivedFile	Array of files found in the archive.
NbFile	entier	Number of files found in the archive. This property is read-only.
NbPart	entier	Number of parts in a multi-volume archive. For a single-volume archive, this property is equal to 1. This property is read-only.
Password	Character string	Password that will be used to add files into the archive or to extract files from the archive. For more details, see zipPassword. This property is available in write mode. Format 7z: It is not possible to use a password. TAR, gzip and TGZ format (TAR.GZ): It is not possible to use a password.
Size	8-byte integer	Total size of the files in the archive (decompressed size). This property is read-only.

Remarks

Functions that use zipArchive variables:


zipAddDirectory	Adds all the files found in a directory and in its subdirectories into an archive and compresses them.
zipAddFile	Automatically adds and compresses a file (of any type) in a CAB, ZIP, WDZ, 7z, TAR, gzip or TGZ (TAR.GZ) archive.
zipAddFileList	Automatically adds and compresses a list of files (of any type) in an archive in ZIP, CAB, WDZ, 7z, TAR, gzip or TGZ (TAR.GZ) format.
zipChangePath	Modifies the stored path of a file in an archive (in ZIP, WDZ or 7z format).
zipClose	Closes an archive.
zipCompressionLevel	Changes the compression level used when creating an archive in ZIP format or in 7z format.
zipCreate	Creates an archive.
zipCreateExe	Creates a self-extracting archive as a 32-bit executable (.EXE).
zipCurrentFile	Returns the name of the archived file currently handled by the functions for adding and extracting files.
zipDeleteAll	Deletes all files from an archive.
zipDeleteFile	Deletes a file from an archive.
zipDeleteFileList	Deletes a list of files from an archive.
zipExist	Determines whether an archive exists.
zipExtractAll	Extracts all files from an archive and decompresses them.
zipExtractFile	Extracts a file from an archive and automatically decompresses it to a physical location or in memory.
zipExtractFileList	Extracts and decompresses a list of files found in an archive to a physical location.
zipExtractPath	Returns the path of a file found in the archive.
zipFileSize	Returns the size of one of the archive files (in CAB, RAR, WDZ, ZIP, 7z, gzip, TAR or TGZ (TAR.GZ) format): the compressed size of the file. the size of file before compression.
zipFindFile	Search for a file in an archive (CAB, ZIP, RAR, WDZ, 7z, gzip, TAR or TGZ (TAR.GZ) format).
zipInfoFile	Returns the characteristics of a file found an archive: The name of the file and its stored path. The initial size of the file. The compressed size of file. The date and time of file creation. The date and time of file modification. The date and time of file access. The file attributes. The file encryption mode.
zipIsMulti	Returns the type of the archive: single-part archive or multi-part archive.
zipListFile	Returns the list of files found in an archive.
zipMerge	Merges the different sub-archives found in a multi-part archive to create a single-part archive.
zipNbFile	Returns the number of files found in an archive (in CAB, RAR, ZIP, WDZ or 7z format).
zipNbPart	Returns the number of sub-archives (parts) in an archive in CAB, RAR, ZIP, WDZ, 7z, gzip, TAR or TGZ (TAR.GZ) format.
zipNbPartNeeded	Returns the number of parts of a given size required to split a single-part archive.
zipOpen	Opens an existing archive.
zipOpenCAB	Opens an existing archive in CAB format.
zipOpenRAR	Opens an existing archive in RAR format.
zipPassword	Defines the password used to add files to the specified archive and to extract files from the specified archive (RAR, ZIP and WDZ format).
zipSize	Returns the size of the archive (in ZIP, RAR, CAB, WDZ, 7z, gzip, TAR or TGZ (TAR.GZ) format): the size of all compressed files found in the archive. the size of all files found in the archive before compression.
zipSplit	Splits an archive into several sub-archives of a given size.