zipDeleteAll (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Status of the archive once all the files have been deleted

See also

zipDeleteAll (Function)

In french: zipSupprimeTout

Deletes all files from an archive.

Versions 15 and later

This function is now available for Android applications.

New in version 15

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 19 and later

This function is now available in Windows Store apps mode.

New in version 19

This function is now available in Windows Store apps mode.

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

See additional examples

// Open the archive
ResOpen = zipOpen("MyArchive", "C:\Temp\Archive.zip")
// In Windows Mobile:
// ResOpen = zipOpen("MyArchive", "\Temp\Archive.zip")
IF ResOpen = 0 THEN
...
// Delete all the files
ResDelete = zipDeleteAll("MyArchive")
...
END

MyArchive is zipArchive
// Open the archive
ResOpen = zipOpen(MyArchive, "C:\Temp\Archive.zip")
// In Windows Mobile:
// ResOpen = zipOpen(MyArchive, "\Temp\Archive.zip")

IF ResOpen = 0 THEN
...
// Delete all the files
ResDelete = zipDeleteAll(MyArchive)
...
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 (with quotes) 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 zipArchive variable.
New in version 15
the name of a zipArchive variable.
the name of a zipArchive variable.

Remarks

Use conditions

The files can be deleted from an archive if:

The archive exists (an archive is created by 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 TAR and TGZ (TAR.GZ) format: This function is not available.
Archives in 7z format: The archive is entirely compressed whenever zipDeleteAll is called.

Only the archives in ZIP format are available.

Error codes

The following error codes are returned:

2: Access denied: the user has no sufficient rights.
3: The archive is corrupted.
4: The path does not exist in the archive.
5: Unable to write into the 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.

Remark: To delete an archive, use the functions for managing the files and directories (fDelete for example).

Business / UI classification: Business Logic

Component: wd260zip.dll