Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

ZipGetEntryProps Function

Overview

The ZipGetEntryProps function returns all known information regarding an entry within a Zip Object.

Syntax/Parameters

Syntax

string[] = ZipGetEntryProps ( handle hZip, int index | string name );

Parameters

hZip

A handle for a Zip Object created by using the ZipOpen function.

index

An int specifying the zero-based entry within the Zip Object. Or,

name

A string specifying an entry name. The direction of the slashes is not important.

Return Value

Returns a string array containing key name and value pairs or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

The array has the following key names and meanings:

  Name   Description
  Type   Value will be “File” or “Folder. Not all zip objects specify separate folders.
  Name   Raw entry name. This can be a simple filename, a relative path and filename or just a path. By convention all zip entries use Unix style forward slashes.
  AdjustedName   The name parameter adjusted for MS backslashes.
  Mode   Compression mode code.
  Position   Absolute position of data within the source file as a hex number.
  CompressedSize   Size of compressed data as an decimal representation of the data within the source file.
  ActualSize   Size of the actual extracted data as an decimal representation.
  ModifiedTime   Modified time in ISO-8601 format. This is converted from the legacy MS-DOS time format and therefore has its limitations of no dates prior to 1980 and the resolution is in 2 second intervals.
  CRC   CRC Code for Error Checking.

 

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic