zipArchivedFile (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Properties specific to the description of zipArchivedFile variables

Functions that use the zipArchivedFile variables

See also

zipArchivedFile (Type of variable)

In french: zipFichierArchivé

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 modified using different WLanguage properties.

This type of variable is used:

by the zipArchive variables.
by zipAddFile.

Versions 26 and later

The CAB format is not available.

New in version 26

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.

Versions 26 and later

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available in Android Widget mode.

This type of variable is now available for Android applications.

New in version 26

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available in Android Widget mode.

This type of variable is now available for Android applications.

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available in Android Widget mode.

This type of variable is now available for Android applications.

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 the description of zipArchivedFile variables

The following properties can be used to handle a zipArchivedFile variable:

Name	Type used	Effect

FileAttribute	Character string	One 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 are using this attribute to find out which files have been saved. This information is restored when the file is extracted. This property is not available.
Content	Buffer	Content of the file. This property is available in read-only if the file was already added into an archive.
CreationDate	Character string or DateTime variable	Date of file creation. 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.
LastAccessDate	Character string or DateTime variable	Date 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.
ModificationDate	Character string or DateTime variable	Date of file modification. This date was stored when the file was added into the archive. This information is restored when the file is extracted.
EncryptionMode	Character string	Character 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.
Name	Character string	Path of the file stored when the file was added into the archive.
Size	8-byte integer	Initial size of the file stored when the file was added into the archive. This property is read-only.
CompressedSize	8-byte integer	Size occupied by the compressed file in the archive. This property is read-only.

Functions that use the zipArchivedFile variables


Versions 09 and later zipAddFile New in version 09 zipAddFile zipAddFile	Adds a file (of any type) into an archive in CAB, ZIP, WDZ and 7z, TAR or TGZ (TAR.GZ) format and compresses it.