<zipArchive variable>.DeleteAll (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Archive management functions

Prefix syntax

DeleteAll

Presentation

Example

Use conditions

Error codes

Status of the archive once all the files have been deleted

See also

<zipArchive variable>.DeleteAll (Function)

In french: <Variable zipArchive>.SupprimeTout

Deletes all files from an archive.

Example

MyArchive is zipArchive
// Open the archive
ResOpen = MyArchive.Open("C:\Temp\Archive.zip")

IF ResOpen = 0 THEN
...
// Delete all the files
ResDelete = MyArchive.DeleteAll()
...
END

Syntax

<Result> = <Archive>.DeleteAll()

<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>: zipArchive variable

Name of a variable of type zipArchive corresponding to the archive to use.

Remarks

Use conditions

The files can be deleted from an archive if:

The archive exists (archives are created using <zipArchive variable>.Create).
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 <zipArchive variable>.DeleteAll is called.

Only ZIP archives 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 file and directory management functions (fDelete for example).

Component: wd280zip.dll