zipCompressionLevel (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Compression level and addition time

Notes

See also

Archiving functions (management of ZIP, WDZ, CAB, RAR, 7z, TAR and TGZ (TAR.GZ))

Constants for the archiving functions

The archives

The single-part and multi-part archives

zipAddDirectory (Example)

zipChangePath (Example)

zipCreateExe (Example)

zipCreateExe

zipCurrentFile (Example)

zipCurrentFile

zipDeleteAll (Example)

zipDeleteAll

zipDeleteFile (Example)

zipDeleteFile

zipDeleteFileList

zipExist

zipExtractAll (Example)

zipExtractAll

zipExtractDirectory

zipExtractFile (Example)

zipExtractFile

zipExtractFileList

zipExtractPath (Example)

zipExtractPath

zipFileSize (Example)

zipFileSize

zipFilter

zipFindFile (Example)

zipFindFile

zipInfoFile (Example)

zipInfoFile

zipIsMulti (Example)

zipIsMulti

zipListFile (Example)

zipListFile

zipMerge (Example)

zipMerge

zipMsgError (Example)

zipNbPartNeeded (Example)

This content has been translated automatically. Click here to view the French version.

Error codes
Compression level and addition time
Notes

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

zipCompressionLevel (Function)

In french: zipNiveauCompression

Changes the compression level used when creating an archive in ZIP format or in 7z format.

Versions 15 and later

This function is now available for Java applications.

This function is now available for Android applications.

New in version 15

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available for Java applications.

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android widget mode.

This function now supports the 7z format.

New in version 18

This function is now available in Android widget mode.

This function now supports the 7z format.

This function is now available in Android widget mode.

This function now supports the 7z format.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

NumZipErr is int
MyArchive is zipArchive

// Create the archive named "MyArchive"
NumZipErr = zipCreate(MyArchive, "C:\MyDocuments\Archive.zip")
IF NumZipErr <> 0 THEN
Error(zipMsgError(NumZipErr))
RETURN
END

// Add a file and use the default compression level (6)
NumZipErr = zipAddFile(MyArchive, "C:\MyImages\Image1.jpg", zipNone)
IF NumZipErr <> 0 THEN
Error(zipMsgError(NumZipErr) + "On the file " + zipCurrentFile(MyArchive))
END

// Change the compression level
// The next file will be stored (no compression)
zipCompressionLevel(MyArchive, 0)

// Add a file
NumZipErr = zipAddFile(MyArchive, "C:\MyImages\Image2.jpg", zipNone)
IF NumZipErr <> 0 THEN
Error(zipMsgError(NumZipErr) + "On the file " + zipCurrentFile(MyArchive))
END

Syntax

<Result> = zipCompressionLevel(<Archive> , <Compression level>)

<Result>: Integer

0 if the compression level was changed,
An error code (value greater than 0) otherwise (see the Notes).

<Archive>: Character string or zipArchive variable

Name of archive to use.
This name can correspond to:
the name of an archive, defined by zipOpen or zipCreate.
Versions 15 and later
the name of a variable of type zipArchive.
New in version 15
the name of a variable of type zipArchive.
the name of a variable of type zipArchive.
Versions 26 and later
zipArchive variables are now available.
New in version 26
zipArchive variables are now available.
zipArchive variables are now available.

<Compression level>: Integer

Value included between 0 (storage without compression) and 9 (maximum compression).
The default compression level is set to 6.

Remarks

Error codes

The following error codes are returned:

15: Archive in CAB format.
27: Archive in WDZ format.
28: Invalid compression level.

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

Compression level and addition time

Caution: A high compression level means that adding a file into the archive will take longer.

Notes

The compression level is defined by the call to the function for all the files that will be added to the archive thereafter (the compression level for the files already found in the archive remains the same).

Caution: Unable to change the compression level of a file found in an existing archive.

Business / UI classification: Business Logic

Component: wd270zip.dll