Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

ZipGetEntryCompressionType Function

Overview

The ZipGetEntryCompressionType function returns the compression mode used to create an entry within a Zip Object.

Syntax/Parameters

Syntax

int = ZipGetEntryCompressionType ( handle hZip, int index | string name );

Parameters

hZip

A handle for a Zip Object created with 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 an int as a compression mode code or a formatted error code on failure.

Remarks

The modes are as follows (courtesy PK Zip AppNote 632):

  0 - The file is stored (no compression)

  1 - The file is Shrunk†

  2 - The file is Reduced with compression factor 1†

  3 - The file is Reduced with compression factor 2†

  4 - The file is Reduced with compression factor 3†

  5 - The file is Reduced with compression factor 4†

  6 - The file is Imploded†

  7 - Reserved for Tokenizing compression algorithm†

  8 - The file is Deflated

  9 - Enhanced Deflating using Deflate64(tm)

10 - PKWARE Data Compression Library Imploding (old IBM TERSE)†

11 - Reserved by PKWARE†

12 - File is compressed using BZIP2 algorithm†

13 - Reserved by PKWARE†

14 - LZMA (EFS)†

15 - Reserved by PKWARE†

16 - Reserved by PKWARE†

17 - Reserved by PKWARE†

18 - File is compressed using IBM TERSE (new)†

19 - IBM LZ77 z Architecture (PFS)†

97 - WavPack compressed data 98 - PPMd version I, Rev 1†

† Not supported by Legato.

Related Functions

Platform Support

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

Legato IDE, Legato Basic