Deletes all files from an archive.
<Result> = zipDeleteAll(<Archive>)
- 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:
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.
- 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.
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.
: To delete an archive, use file and directory management functions (fDelete
Business / UI classification: Business Logic