|
|
|
|
|
|
|
|
- Use conditions
- Error codes
- Index of files in the archive
- Stored path
<zipArchive variable>.DeleteFile (Function) In french: <Variable zipArchive>.SupprimeFichier Deletes a file from an archive.  New in version 28Syntax
Deleting a file using its index Hide the details
<Result> = <Archive>.DeleteFile(<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>: zipArchive variable Name of a variable of type zipArchive corresponding to the archive to use. <File index>: Integer Index of the file to be deleted from the archive. <zipArchive variable>.FindFile returns this index.
Deleting a file according to its path Hide the details
<Result> = <Archive name>.DeleteFile(<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 name>: zipArchive variable Name of a variable of type zipArchive corresponding to the archive to use. <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 <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 or TGZ (TAR.GZ) format: This function is not available.
- Archives in 7z format: The archive is entirely compressed whenever <zipArchive variable>.DeleteFile is called. This function is recommended when deleting a single file. If several files must be deleted from the archive, use <zipArchive variable>.DeleteFileList.
Reminder:   Only ZIP, TAR and TGZ (TAR.GZ) 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: 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.
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|