zipDeleteAll (Function)

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

Use conditions
Error codes
Status of the archive once all the files have been deleted

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

zipDeleteAll (Function)

In french: zipSupprimeTout

Deletes all files from an archive.

Example

See additional examples

MonArchive is zipArchive
// Ouverture de l'archive
ResOuverture = zipOpen(MonArchive, "C:\Temp\Archive.zip")

IF ResOuverture = 0 THEN
	...
	// Suppression de tous les fichiers
	ResSuppression = zipDeleteAll(MonArchive)
	...
END

Syntax

<Result> = zipDeleteAll(<Archive>)

<Result>: Integer

0 if the files have been deleted,
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:
an archive name defined with zipOpen or zipCreate.
the name of a variable of type zipArchive.
zipArchive variables are not available in Java.

Remarks

Use conditions

The files can be deleted from an archive if:

The archive exists (archives are created using zipCreate).
The archive is accessible in read/write.
The archive is a single-part archive.

Caution:

Archives in RAR format: This function is not available.
Archives in CAB format: This function is not available.
Archives in gzip, TAR and TGZ format (TAR.GZ): This function is not available.
Archives in 7z format: The archive is fully compressed each time the function is called zipDeleteAll.

Only ZIP archives are available.

Error codes

The following error codes are returned:

2: Access denied: user does not have sufficient rights.
3: The archive is corrupt.
4: The path does not exist in the archive.
5: Unable to write to archive.

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

Status of the archive once all the files have been deleted

Once all the files have been deleted, the archive is empty. The archive is not closed. The physical file corresponding to the archive is still there and usable.

Note To delete an archive, use the file and directory management functions (e.g. fDelete).

Business / UI classification: Business Logic

Component: wd300zip.dll