PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Use conditions
  • Error codes
  • Index 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/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Deletes a file from an archive.
Versions 15 and later
Android This function is now available for Android applications.
New in version 15
Android This function is now available for Android applications.
Android This function is now available for Android applications.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for 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 QueriesUser code (UMC)Ajax
MyArchive is zipArchive
// Create the archive
ResOpen = zipOpen(MyArchive, "C:\Temp\Archive.zip")
IF ResOpen = 0 THEN
...
// Delete "File.doc"
ResDelete = zipDeleteFile(MyArchive, "File.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:
  • the name of an archive, defined by zipOpen or zipCreate.
  • Versions 15 and later
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    New in version 15
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    Versions 26 and later
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    New in version 26
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
<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:
  • the name of an archive, defined by zipOpen or zipCreate.
  • Versions 15 and later
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    New in version 15
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystAjax the name of a variable of type zipArchive.
    Versions 26 and later
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    New in version 26
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst zipArchive variables are now available.
    AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst 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:
  • LinuxUniversal Windows 10 AppiPhone/iPadIOS WidgetMac Catalyst Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
  • AndroidAndroid Widget Java 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 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".
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

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.
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.
Business / UI classification: Business Logic
Component: wd270zip.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment