PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • 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
zipDeleteFileList (Function)
In French: zipSupprimeListeFichier
Deletes a list of files from an archive. This function is faster than zipDeleteFile run for each file.
Versions 15 and later
Android This function is now available for the Android applications.
New in version 15
Android This function is now available for the Android applications.
Android This function is now available for the Android applications.
Versions 17 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 18 and later
Android Widget This function is now available in Android Widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
New in version 18
Android Widget This function is now available in Android Widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
Android Widget This function is now available in Android Widget mode.
WINDEVWEBDEV - Server codeWindows This function now supports the 7z format.
Versions 19 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 19
Universal Windows 10 App This function is now available in Windows Store apps mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Example
WINDEVWEBDEV - Server codeReports and QueriesJavaAjaxUser code (UMC)
// Create the archive
ResOpen = zipOpen("MyArchive", "C:\Temp\Archive.zip")
IF ResOpen = 0 THEN
        ...
       // Delete "File.doc" and "MyDoc.pdf"
        ResDelete = zipDeleteFileList("MyArchive", "File.doc" + CR + "MyDoc.PDF")
        ...
END
Windows Mobile
// Create the archive
ResOpen = zipOpen("MyArchive", "\Temp\Archive.zip")
IF ResOpen = 0 THEN
        ...
       // Delete "File.txt" and "MyDoc.pdf"
        ResDelete = zipDeleteFileList("MyArchive", "File.txt" + CR + "MyDoc.PDF")
        ...
END
Syntax
<Result> = zipDeleteFileList(<Archive> , <Path of Files to Delete> [, <Management of Progress Bar>])
<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 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).
<Management of Progress Bar>: Optional character string (with or without quotes)
Versions 21 and later
Mode for managing the progress bar. This parameter can correspond to:
  • WINDEViPhone/iPadWindows MobileUniversal Windows 10 App the name of a Progress Bar control found in a window. The progress bar will display the progress of file deletion.
  • the name of a WLanguage procedure. This procedure has the following format:
    <Procedure Name> (<Current File>, <Percentage of Progress>)

    where:
    • <Current File> corresponds to the name of the file currently processed.
    • <Percentage of Progress> corresponds to the percentage of progress regarding the deletion of the list of files 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.
WEBDEV - Server code The procedure must be a server procedure.
New in version 21
Mode for managing the progress bar. This parameter can correspond to:
  • WINDEViPhone/iPadWindows MobileUniversal Windows 10 App the name of a Progress Bar control found in a window. The progress bar will display the progress of file deletion.
  • the name of a WLanguage procedure. This procedure has the following format:
    <Procedure Name> (<Current File>, <Percentage of Progress>)

    where:
    • <Current File> corresponds to the name of the file currently processed.
    • <Percentage of Progress> corresponds to the percentage of progress regarding the deletion of the list of files 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.
WEBDEV - Server code The procedure must be a server procedure.
Mode for managing the progress bar. This parameter can correspond to:
  • WINDEViPhone/iPadWindows MobileUniversal Windows 10 App the name of a Progress Bar control found in a window. The progress bar will display the progress of file deletion.
  • the name of a WLanguage procedure. This procedure has the following format:
    <Procedure Name> (<Current File>, <Percentage of Progress>)

    where:
    • <Current File> corresponds to the name of the file currently processed.
    • <Percentage of Progress> corresponds to the percentage of progress regarding the deletion of the list of files 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.
WEBDEV - Server code The procedure must be a server procedure.
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.
LinuxAndroidAndroid Widget iPhone/iPadWindows MobileUniversal Windows 10 AppJava Only the archives in ZIP format 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.

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.
AndroidAndroid Widget Java The zipDrive constant is equivalent to the zipDirectory constant.
Universal Windows 10 App The directory and the disk are not stored in the archive path. Only the file name and extension are stored.
Windows Mobile The table below presents the paths stored in the archive according to:
  • the access path to the file,
  • the path section to store.
zipAddFileFile locationzipNonezipDirectory
zipAddFile("Archi",
"\File.txt")
\File.txtFile.txtFile.txt
zipAddFile("Archi",
"\Temp\File.txt")
\Temp\File.txtFile.txtTemp\File.txt
Components
WINDEVWEBDEV - Server codeReports and Queries wd230zip.dll
Windows Mobile wp230zip.dll
Java wd230java.jar
Linux wd230zip.so
Android wd230android.jar
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment