zipDeleteFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Archive management functions

Prefix syntax

WLanguage procedure

zipDeleteFile

Presentation

Example

Use conditions

Error codes

Index of files in the archive

Stored path

See also

<Variable zipArchive>.ChangeChemin

<Variable zipArchive>SearchFile

Archiving functions (management of ZIP, WDZ, CAB, RAR, 7z, TAR and TGZ (TAR.GZ))

Constants for the archiving functions

The archives

The single-part and multi-part archives

zipAddDirectory (Example)

zipAddDirectory

zipAddFile (Example)

zipAddFile

zipAddFileList

zipArchive

zipArchivedFile

zipChangePath (Example)

zipChangePath

zipClose (Example)

zipClose

zipCompressionLevel

zipCreate (Example)

zipCreate

zipCreateExe (Example)

zipCreateExe

zipCurrentFile (Example)

zipCurrentFile

zipDeleteAll (Example)

zipDeleteAll

zipDeleteFile (Example)

zipDeleteFile

zipDeleteFileList

zipExist

zipExtractAll (Example)

zipExtractAll

zipExtractDirectory

zipExtractFile (Example)

zipExtractFile

zipExtractFileList

zipExtractPath (Example)

zipExtractPath

zipFileSize (Example)

zipFileSize

zipFilter

zipFindFile (Example)

zipFindFile

zipInfoFile (Example)

zipInfoFile

zipIsMulti (Example)

zipIsMulti

zipListFile (Example)

zipListFile

zipMerge (Example)

zipMerge

zipMsgError (Example)

zipMsgError

zipNbFile (Example)

zipNbFile

zipNbPart (Example)

zipNbPart

zipNbPartNeeded (Example)

zipNbPartNeeded

zipOpen (Example)

zipOpen

zipOpenCAB (Example)

zipOpenCAB

zipOpenRAR (Example)

zipOpenRAR

zipPassword

zipSelectFile

zipSize (Example)

zipSize

zipSplit (Example)

zipSplit

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

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.

New in version 28

The zipArchive type is now available for UWP applications.

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>: entier

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.
Variables of type zipArchive are not available in Java.
New in version 28
zipArchive variables are now available.

<File index>: entier

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>: entier

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.
Variables of type zipArchive are not available in Java.
New in version 28
zipArchive variables are now available.

<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 (TAR.GZ) format: This function is not available.
Archives in 7z format: The archive is entirely compressed whenever zipDeleteFile is called. This function is recommended when deleting a single file. If several files must be deleted from the archive, use zipDeleteFileList.

Reminder:

Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
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.

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: Once the files have been deleted, the indices of the remaining files are modified. The indices 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 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 zipDrive constant is equivalent to the zipDirectory constant.

The directory and the disk are not stored in the archive path. Only the file name and extension are stored.

Business / UI classification: Business Logic

Component: wd280zip.dll