zipInfoFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Index of files in the archive

Stored path

Encrypting a file in an archive

See also

zipInfoFile (Function)

In french: zipInfoFichier

Returns the characteristics of a file found an archive:

The name of the file and its stored path.
The initial size of the file.
The compressed size of file.
The date and time of file creation.
The date and time of file modification.
The date and time of file access.
The file attributes.
The file encryption mode.

The archive file can be identified by its number or by its path in the archive.

The following characteristics are not available: the file creation and access date and time, and the file encryption mode.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android widget mode.

This function now supports the 7z format.

New in version 18

This function is now available in Android widget mode.

This function now supports the 7z format.

This function is now available in Android widget mode.

This function now supports the 7z format.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

This function now supports the TAR and TGZ (TAR.GZ) formats.

New in version 21

This function is now available in Universal Windows 10 App mode.

This function now supports the TAR and TGZ (TAR.GZ) formats.

This function is now available in Universal Windows 10 App mode.

This function now supports the TAR and TGZ (TAR.GZ) formats.

Example

See additional examples

Archive is zipArchive

// Open an archive
ResOpenArchive = zipOpen(Archive, "C:\Archives\Archive.zip")

IF ResOpenArchive = 0 THEN
...
// Information about an archive file
ResFileInfo = zipInfoFile(Archive, "C:\Directory\File.doc")
// Display the file information
Info("The file information is: ", ResFileInfo)
...
END

Syntax

Getting the details of a file identified by its index Hide the details

<Result> = zipInfoFile(<Archive> , <File index in the archive>)

<Result>: Character string

Empty string if the function failed (file not found in the archive, etc.).
Characteristics of the file found in the specified archive:

<File path and name> + TAB + <Initial file size> + TAB +
<Compressed file size> + TAB +
<Date and time of file creation (YYYYMMDDHHmmSS)> + TAB +
<Date and time of file modification (YYYYMMDDHHmmSS)> + TAB +
<Date and time of file access (YYYYMMDDHHmmSS)> + TAB +
<File attributes> + TAB + <File encryption mode>

The file attributes correspond to one or more letters (or "ERR" if an error occurred). 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 system file of Windows.
A: "Archive" file. This attribute indicates that the file can be archived. Some programs use this attribute to determine which files have been saved.
D: Directory or subdirectory. The file is a directory or a subdirectory.
The file encryption encryption is "+" for an encrypted file (zip or WDZ) and "N" for a standard file.
Archives in Zip format and in 7z format: Only the date of last modification is returned.
The returned string has the following format:

<File path and name> + TAB + <Initial file size> + TAB +
<Compressed file size> + TAB +
<Date and time of file modification (YYYYMMDDHHmmSS)> + TAB +
<File attributes>

<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
the name of a variable of type zipArchive.
New in version 15
the name of a variable of type zipArchive.
the name of a variable of type zipArchive.
Versions 26 and later
zipArchive variables are now available.
New in version 26
zipArchive variables are now available.
zipArchive variables are now available.

<File index in the archive>: Integer

Index of a file in the archive. The characteristics of this file are requested. zipFindFile returns this index.

Finding out information about a file identified by its path Hide the details

<Result> = zipInfoFile(<Archive> , <File path in archive>)

<Result>: Character string

Empty string if the function failed (file not found in the archive, etc.).
Characteristics of the file found in the specified archive:

<File path and name> + TAB + <Initial file size> + TAB +
<Compressed file size> + TAB +
<Date and time of file creation (YYYYMMDDHHmmSS)> + TAB +
<Date and time of file modification (YYYYMMDDHHmmSS)> + TAB +
<Date and time of file access (YYYYMMDDHHmmSS)> + TAB +
<File attributes> + TAB + <File encryption mode>

The file attributes correspond to one or more letters (or "ERR" if an error occurred). 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 system file of Windows.
A: "Archive" file. This attribute indicates that the file can be archived. Some programs use this attribute to determine which files have been saved.
D: Directory or subdirectory. The file is a directory or a subdirectory.
The file encryption mode corresponds to "+" for an encrypted file (in zip or WDZ format) and to "N" for a standard file.
Archives in Zip format and in 7z format: Only the date of last modification is returned.
The returned string has the following format:

<File path and name> + TAB + <Initial file size> + TAB +
<Compressed file size> + TAB +
<Date and time of file modification (YYYYMMDDHHmmSS)> + TAB +
<File attributes>

<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
the name of a variable of type zipArchive.
New in version 15
the name of a variable of type zipArchive.
the name of a variable of type zipArchive.
Versions 26 and later
zipArchive variables are now available.
New in version 26
zipArchive variables are now available.
zipArchive variables are now available.

<File path in archive>: Character string

Stored path of a file found in the archive. The characteristics of this file are requested.

Remarks

Reminder

Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
Only ZIP archives are available.

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.

Stored path

The table below presents the paths stored in the archive according to:

the access path to the file,
the stored path section.

The current directory is: "C:\Temp".


zipAddFile	File location	zipNone	zipDirectory	zipDrive
zipAddFile("Archi", "File.txt")	C:\Temp\File.txt	File.txt	File.txt	File.txt
zipAddFile("Archi", "Data\File.txt")	C:\Temp\Data\File.txt	File.txt	Data\File.txt	Data\File.txt
zipAddFile("Archi", "D:\Data\File.txt")	D:\Data\File.txt	File.txt	Data\File.txt	D:\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.

The zipDrive constant is ignored.

Encrypting a file in an archive

A file can be encrypted in an archive by zipPassword.

Business / UI classification: Business Logic

Component: wd270zip.dll