zipDeleteFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

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

zipDeleteFile (Function)

In french: zipSupprimeFichier

Deletes a file from an archive.

Example

See additional examples

MonArchive is zipArchive
// Création de l'archive
ResOuverture = zipOpen(MonArchive, "C:\Temp\Archive.zip")
IF ResOuverture = 0 THEN
...
	// Suppression de "Fichier.doc"
	ResSuppression = zipDeleteFile(MonArchive, "Fichier.doc")
...
END

Syntax

Deleting a file using its index Hide the details

<Result> = zipDeleteFile(<Archive> , <File index>)

<Result>: Integer

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

<Archive>: Character string or zipArchive variable

Name of the archive to be used.
This name can correspond to:
an archive name defined with zipOpen or zipCreate.
the name of a variable of type zipArchive.
zipArchive variables are not available in Java.

<File index>: Integer

Index of the file to be deleted from the archive. zipFindFile returns this index.

Deleting a file according to its path Hide the details

<Result> = zipDeleteFile(<Archive> , <File path>)

<Result>: Integer

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

<Archive>: Character string or zipArchive variable

Name of the archive to be used.
This name can correspond to:
an archive name defined with zipOpen or zipCreate.
the name of a variable of type zipArchive.
zipArchive variables are not available in Java.

<File path>: Character string

Stored path of the file that must be deleted from the archive.

Remarks

Use conditions

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.

Caution:

Archives in RAR format: This function is not available.
Archives in CAB format: This function is not available.
Archives in TAR or TGZ format (TAR.GZ): This function is not available.
Archives in 7z format: The archive is fully compressed each time the function is called zipDeleteFile. This function is recommended when deleting a single file. If several files must be deleted from the archive, use zipDeleteFileList.

Reminder:

Only archives in ZIP, gzip, TAR and TGZ (TAR.GZ) formats are available.
Only ZIP archives are available.

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

When a file is added into an archive, an index is automatically assigned to the file. This index corresponds to the order in which the files are included in the archive.

To select a file in the archive, you can use:

The index of the element (the index of an element is returned by zipFindFile).
The stored path of the element.

Important: After file deletion, files in an archive are re-indexed.. 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.

The zipDrive constant is equivalent to the zipDirectory constant.

Business / UI classification: Business Logic

Component: wd300zip.dll