<zipArchive variable>.DeleteFileList (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Use conditions
Error codes
Subscript of files in the archive
Stored path

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<zipArchive variable>.DeleteFileList (Function)

In french: <Variable zipArchive>.SupprimeListeFichier

Deletes a list of files from an archive. This function is faster than <zipArchive variable>.DeleteFile run for each file.

Versions 18 and later

This function now supports the 7z format.

New in version 18

This function now supports the 7z format.

Example

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

IF ResOpen = 0 THEN
...
// Delete "File.doc" and "MyDoc.pdf"
ResDelete = MyArchive.DeleteFileList("File.doc" + CR + "MyDoc.PDF")
...
END

Syntax

<Result> = <Archive>.DeleteFileList(<Path of the files to delete> [, <Progress bar management>])

<Result>: Integer

0 if the files have been deleted,
An error code (value greater than 0) otherwise. The message corresponding to the error code is returned by zipMsgError.

<Archive>: zipArchive variable

Name of a zipArchive variable that corresponds to the archive to use.

<Path of the files to delete>: Character string (with quotes)

Stored path of the file that must be deleted from the archive. The paths are separated by CR characters (Carriage Return).

<Progress bar management>: Optional character string (with or without quotes)

Versions 21 and later
Mode for managing the progress bar. This parameter can correspond to:
the name of a Progress Bar control found in a window. The progress bar will display the progress of file deletion.
the name of a WLanguage procedure. This procedure has the following format:

<Procedure name> (<Current file>, <Progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Progress percentage> corresponds to the progress percentage of the file list being deleted from the archive.
If you are using an archive in TAR or TGZ (TAR.GZ) format, the progress bar is updated at the end of file addition only.
The procedure must be a server procedure.
New in version 21
Mode for managing the progress bar. This parameter can correspond to:
the name of a Progress Bar control found in a window. The progress bar will display the progress of file deletion.
the name of a WLanguage procedure. This procedure has the following format:

<Procedure name> (<Current file>, <Progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Progress percentage> corresponds to the progress percentage of the file list being deleted from the archive.
If you are using an archive in TAR or TGZ (TAR.GZ) format, the progress bar is updated at the end of file addition only.
The procedure must be a server procedure.
Mode for managing the progress bar. This parameter can correspond to:
the name of a Progress Bar control found in a window. The progress bar will display the progress of file deletion.
the name of a WLanguage procedure. This procedure has the following format:

<Procedure name> (<Current file>, <Progress percentage>)

where:
<Current file> corresponds to the name of the file currently processed.
<Progress percentage> corresponds to the progress percentage of the file list being deleted from the archive.
If you are using an archive in TAR or TGZ (TAR.GZ) format, the progress bar is updated at the end of file addition only.
The procedure must be a server procedure.

Remarks

Use conditions

The files can be deleted from an archive if:

The archive exists (an archive is created by <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>.DeleteFileList 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.

Subscript of files in the archive

Once the files have been deleted, the subscripts of the remaining files are modified. The subscripts of the files found after the deleted file are automatically decremented by 1.

Stored path

The table below presents the paths stored in the archive according to:

the access path to the file,
the path section to store.

The current directory is: "C:\Temp".


zipAddFile	File location	zipNone	zipDirectory	zipDrive
zipAddFile("Archi", "File.txt")	C:\Temp\File.txt	File.txt	File.txt	File.txt
zipAddFile("Archi", "Data\File.txt")	C:\Temp\Data\File.txt	File.txt	Data\File.txt	Data\File.txt
zipAddFile("Archi", "D:\Data\File.txt")	D:\Data\File.txt	File.txt	Data\File.txt	D:\Data\File.txt

Remark: If the zipDrive constant is used, the WDZ format stores the full path of the file (including the drive letter) while the ZIP format does not store the drive letter.

The table below presents the paths stored in the archive according to:

the access path to the file,
the path section to store.


zipAddFile	File location	zipNone	zipDirectory
zipAddFile("Archi", "\File.txt")	\File.txt	File.txt	File.txt
zipAddFile("Archi", "\Temp\File.txt")	\Temp\File.txt	File.txt	Temp\File.txt

Component: wd260zip.dll