<zipArchive variable>.Create (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Level of compression
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).
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 (TAR.GZ) format (.TGZ or.TAR.GZ extension).
New in version 21
in TGZ (TAR.GZ) format (.TGZ or.TAR.GZ extension).
in TGZ (TAR.GZ) format (.TGZ or.TAR.GZ extension).No archive in "RAR" format can be created.

Versions 18 and later

This function now supports the 7z format.

New in version 18

This function now supports the 7z format.

Versions 21 and later

This function now supports the TAR and TGZ (TAR.GZ) formats.

New in version 21

This function now supports the TAR and TGZ (TAR.GZ) formats.

Example

MyArchive is zipArchive

// 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 zipArchive variable that corresponds to the archive to use.

<Archive path>: Character string (with quotes)

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.
Versions 18 and later
".7z" to create an archive in 7Z format.
New in version 18
".7z" to create an archive in 7Z format.
".7z" to create an archive in 7Z format.
Versions 21 and later
".TAR" to create an archive in TAR format.
New in version 21
".TAR" to create an archive in TAR format.
".TAR" to create an archive in TAR format.
Versions 21 and later
".TAR.GZ" to create an archive in TAR.GZ format.
New in version 21
".TAR.GZ" to create an archive in TAR.GZ format.
".TAR.GZ" to create an archive in TAR.GZ format.
Versions 21 and later
".TGZ" to create an archive in TGZ format.
New in version 21
".TGZ" to create an archive in TGZ format.
".TGZ" to create an archive in TGZ format.
If no extension is specified, an archive in WDZ format is created.
Caution:
Only the archives in ZIP, TAR and TGZ (TAR.GZ) format 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:
Versions 17 and later
zipAnsi
New in version 17
zipAnsi
zipAnsi Used to force the backup of file names in Ansi format in the Archive file.
This constant is used by default in an application that is using the Ansi mode.
zipHeader64 Allows you to create an archive exceeding 4 GB on which zipChangePath can be used.
By default, this option is not used.
Versions 21 and later
Archive in TAR or TGZ format (TAR.GZ): This constant is not available.
New in version 21
Archive in TAR or TGZ format (TAR.GZ): This constant is not available.
Archive in TAR or TGZ format (TAR.GZ): This constant is not available.
zipUncompressed The content 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.
Versions 21 and later
Archive in TAR or TGZ format (TAR.GZ): This constant is not available.
New in version 21
Archive in TAR or TGZ format (TAR.GZ): This constant is not available.
Archive in TAR or TGZ format (TAR.GZ): This constant is not available.
Versions 17 and later
zipUnicode
New in version 17
zipUnicode
zipUnicode Used to force the backup of file names in Unicode format in the Archive file.
This constant is used by default in an application that is using the Unicode mode.
Versions 21 and later
Archive in TAR or TGZ format (TAR.GZ): If this constant is used, file names in Unicode format are not saved in Unicode in the Archive file..
New in version 21
Archive in TAR 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 in TAR 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 in 7z format: This parameter is not available.

Remarks

Level of compression

The files added into an archive in Zip format are compressed by default. The compression level of files added into an archive can be modified by zipCompressionLevel.

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.

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

Use condition

The maximum number of files that can be included:

in a WDZ file: 2³²-1.
in a ZIP file: 65535.
in a CAB file: 65535.

Available formats:

Only the archives in ZIP, TAR and TGZ (TAR.GZ) format 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 : wd260zip.dll