<zipArchive variable>.Create (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Archive functions

Compression level
Error codes
Use condition

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<zipArchive variable>.Create (Function)

In french: <Variable zipArchive>.Crée

Creates an archive. The created archive is automatically:

opened in read/write. If the archive is in CAB format, the created archive is opened in write-only.
a single-part archive.

The created archive can be:

in standard WinZip or PKZip format (.ZIP extension).
in "Cabinet files" format (.CAB extension).
in WINDEV format (.WDZ extension).
in 7z format (.7z extension).
in TAR format (.TAR extension).
in TGZ (TAR.GZ) format (.TGZ or .TAR.GZ extension).
New in version 2025
in gzip format (.gz extension).
No archive in "RAR" format can be created.

Example

MyArchive is zipArchive
ResCreate is int
ResAddFile is int
// Create the archive 
ResCreate = MyArchive.Create("C:\Temp\Archive.zip")
IF ResCreate = 0 THEN
	// Add a file into an archive
	ResAddFile = MyArchive.AddFile(...
			"C:\MyDirectory\MyFiles\File.pdf", zipDrive)
END
// Display an error message if the file was not added
IF ResAddFile <> 0 THEN 
	Error(zipMsgError(ResAddFile))
END

Syntax

<Result> = <Archive>.Create(<Archive path> [, <Options>])

<Result>: Integer

0 if the creation was performed. In this case, the archive is opened. In order for this archive to be handled by the user before closing the application, don't forget to close the archive (<zipArchive variable>.Close).
An error code (value greater than 0) otherwise. For more details on these error codes, see the Remarks.

<Archive>: zipArchive variable

Name of a variable of type zipArchive corresponding to the archive to be used.

<Archive path>: Character string

Path and name of archive (up to 260 characters). The archive extension must be specified:
".WDZ" to create a WINDEV archive.
".ZIP" to create an archive in WinZip or PKZip format.
".CAB" to create an archive in "Cabinet Files" format.
".7z" to create an archive in 7Z format.
".TAR" to create an archive in TAR format.
".TAR.GZ" to create an archive in TAR.GZ format.
".TGZ" to create an archive in TGZ format.
New in version 2025
".gz" to create an archive in gzip format.
If no extension is specified, an archive in WDZ format is created.
Caution:
Only archives in ZIP, gzip, TAR and TGZ (TAR.GZ) formats are available.
If the same archive already exists in the specified directory, this archive is overwritten by the new archive.

<Options>: Optional constant

Options for managing the archives:
zipAnsi Used to force the backup of file names in Ansi format in the Archive file.
This constant is used by default in applications using the ANSI standard.
zipHeader64 Allows you to:
create an archive larger than 4 gigabytes on which the <zipArchive variable>.ChangePath function can be used.
increase the number of files in a ZIP archive. The default limit is 65535 files.. Using this constant, the limit increases to 4,294,967,295 files..
By default, this option is not used.
Archive in TAR, gzip or TGZ format (TAR.GZ): This constant is not available.
zipUncompressed The contents of the archive will not be compressed.
Used with the CAB archives, this constant allows you to only use the function for archiving the CAB format.
By default, this option is not used.
Archive in TAR, gzip or TGZ format (TAR.GZ): This constant is not available.
zipUnicode Saves Unicode file names in the Archive file.
This constant is used by default in an application using Unicode.
Archive in TAR, gzip or TGZ format (TAR.GZ) If this constant is used, file names in Unicode format are not saved in Unicode in the Archive file.

Archive format 7z: This parameter is not available.

Remarks

Compression level

The files added into a zip archive are compressed by default. You can change the compression level of files added to an archive using function zipCompressionLevel.

Error codes

The following error codes are returned:

1: The path passed as parameter does not exist.
2: Access denied: user does not have sufficient rights.

The message corresponding to the error code is returned by zipMsgError.

Use condition

Maximum number of files allowed:

in a WDZ file: 2³²-1.
in a ZIP file: 65535.
This limit can be increased to 4,294,967,295 files using the constant zipEntête64.
in a CAB file: 65535.

Available formats:

Only ZIP, TAR, gzip and TGZ (TAR.GZ) archives are available.

The size of a file included in an archive (regardless of its format) must be less than 4 GB.

No archive in "RAR" format can be created.

Component: wd300zip.dll