PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Use conditions
  • Error codes
  • Subscript of files in the archive
  • Stored path
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Deletes a list of files from an archive. This function is faster than zipDeleteFile run for each file.
Versions 18 and later
Windows This function now supports the 7z format.
New in version 18
Windows This function now supports the 7z format.
Windows This function now supports the 7z format.
Example
Reports and Queries
// Create the archive
ResOpen = zipOpen("MyArchive", "C:\Temp\Archive.zip")
// In Windows Mobile:
// ResOpen = zipOpen("MyArchive", "\Temp\Archive.zip")
 
IF ResOpen = 0 THEN
...
// Delete "File.doc" and "MyDoc.pdf"
ResDelete = zipDeleteFileList("MyArchive", "File.doc" + CR + "MyDoc.PDF")
...
END
Reports and Queries
MyArchive is zipArchive
// Create the archive
ResOpen = zipOpen(MyArchive, "C:\Temp\Archive.zip")
// In Windows Mobile:
// ResOpen = zipOpen(MyArchive, "\Temp\Archive.zip")
 
IF ResOpen = 0 THEN
...
// Delete "File.doc" and "MyDoc.pdf"
ResDelete = zipDeleteFileList(MyArchive, "File.doc" + CR + "MyDoc.PDF")
...
END
Syntax
<Result> = zipDeleteFileList(<Archive> , <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>: Character string (with quotes) or zipArchive variable
Name of archive to use.
This name can correspond to:
<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 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.
New in version 21
Mode for managing the progress bar. 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 are using an archive in TAR or TGZ (TAR.GZ) format, the progress bar is updated at the end of file addition only.
Mode for managing the progress bar. 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 are using an archive in TAR or TGZ (TAR.GZ) format, the progress bar is updated at the end of file addition only.
Remarks

Use conditions

The files can be deleted from an archive if:
  • The archive exists (an archive is created by 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 and TGZ (TAR.GZ) format: This function is not available.
  • Archives in 7z format: The archive is entirely compressed whenever zipDeleteFileList is called.

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".
zipAddFileFile locationzipNonezipDirectoryzipDrive
zipAddFile("Archi",
"File.txt")
C:\Temp\File.txtFile.txtFile.txtFile.txt
zipAddFile("Archi",
"Data\File.txt")
C:\Temp\Data\File.txtFile.txtData\File.txtData\File.txt
zipAddFile("Archi",
"D:\Data\File.txt")
D:\Data\File.txtFile.txtData\File.txtD:\Data\File.txt
Note: 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.
Component : wd250zip.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment