ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / Archive functions
  • Properties specific to zipArchivedFile variables
  • Functions that use zipArchivedFile variables
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
The zipArchivedFile type is used to handle:
  • a file found in an archive corresponding to one of the following formats: ZIP, CAB, RAR, WDZ, 7z, TAR or TGZ (TAR.GZ).
  • a file to add into an archive.
The characteristics of this file can be defined and changed using different WLanguage properties.
This type of variable is used:
AndroidAndroid Widget The CAB format is not available.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
Example
// Open an archive file
MyArchive is zipArchive
zipOpen(MyArchive, "c:\Backups\archive.zip")
 
// In the trace, display the list of files found in the archive
FOR EACH ArcFile OF MyArchive.File
Trace(ArcFile.Name)
END
 
// Add a new file into the archive
NewFile is zipArchivedFile
NewFile.Name = "ArchivedFile.txt"
NewFile.Content = "This file was archived"
zipAddFile(MyArchive, NewFile)
Remarks

Properties specific to zipArchivedFile variables

The following properties can be used to handle a zipArchivedFile variable:
NameType usedEffect
CompressedSize8-byte integerSize occupied by the compressed file in the archive.
This property is read-only.
ContentBufferFile content.
This property is available in read-only if the file was already added into an archive.
DateCreatedCharacter string or DateTime variableDate the file was created. This date was stored when the file was added into the archive.
This information is restored when the file is extracted.
This information is stored for the WDZ format only.
This property corresponds to "CreationDate" in previous versions.
DateLastAccessedCharacter string or DateTime variableDate of last access to the file. This date was stored when the file was added into the archive.
This information is restored when the file is extracted.
This information is stored for the WDZ format only.
This constant corresponds to "LastAccessDate" in previous versions.
DateModifiedCharacter string or DateTime variableDate of file modification. This date was stored when the file was added into the archive.
This information is restored when the file is extracted.
This property corresponds to "ModificationDate" in previous versions.
EncryptionModeCharacter stringCharacter indicating whether the archived file is protected by encryption.
The possible values are:
  • N: Standard file.
  • +: Encrypted file (a password will be required to extract the file from the archive).
This property is available in read-only if the file was already added into an archive.
FileAttributeCharacter stringOne or more letters corresponding to the file attributes ("AH" for instance) stored when the file was added into the archive.
The following letters are used:
  • R: Read-only file. The file can be accessed in read-only.
  • H: Hidden file. The file name is grayed or invisible in the explorer.
  • S: System file. The file is a Windows system file.
  • A: "Archive" file. This attribute indicates that the file can be archived. Some programs use this attribute to determine which files have been saved.
This information is restored when the file is extracted.
Linux This property is not available.
NameCharacter stringFile path stored when the file was added to the archive.
Size8-byte integerFile size stored when the file was added to the archive.
This property is read-only.

Functions that use zipArchivedFile variables

zipAddFileAdds a file (of any type) into an archive in CAB, ZIP, WDZ and 7z, TAR or TGZ (TAR.GZ) format and compresses it.
Minimum version required
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 03/28/2023

Send a report | Local help