<zipArchive variable>.DeleteFileList (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Archive functions

Use conditions
Error codes
Index 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.

Example

MonArchive is zipArchive
// Création de l'archive
ResOuverture = MonArchive.Open("C:\Temp\Archive.zip")

IF ResOuverture = 0 THEN
	...
	// Suppression de "Fichier.doc" et de "MonDoc.pdf"
	ResSuppression = MonArchive.DeleteFileList("Fichier.doc" + CR + "MonDoc.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 variable of type zipArchive corresponding to the archive to use.

<Path of the files to delete>: Character string

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

Progress bar management mode. This parameter can correspond to:
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're working with an archive in gzip, TAR or TGZ (TAR.GZ)format, the ProgressBar is updated only when the file has been added.

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 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 <zipArchive variable>.DeleteFileList.

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.

Index of files in the archive

Once the files have been deleted, the indexes of the remaining files are modified. The indexes of the files 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 constant zipDisk is used, WDZ format memorizes the full path of the file (including drive letter), whereas ZIP format does not memorize the drive letter.

Component: wd300zip.dll