Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Add some file to ZIP archive.

...

...

OpenArchive()  

...

Open ZIP archive file.

Syntax:

Code Block
eqZIP::OpenArchive(m.tcZipName, m.tnAppend)

Parameters: 

m.tcZipName 

  The ZIP archive file.

 m.tnAppend

   A append flag. 

 Return values 

  .T. - Archive create/open successfully.
  .F. -  Archive do not create/open successfully. 

...

CloseArchive()  

Close ZIP archive file.

Syntax:  

Code Block
eqZIP::CloseArchive(m.tcComment)

Parameters:

m.tcComment

...

OpenNewFile()  

Open file handle.

Syntax:

Code Block
eqZIP::OpenNewFile(m.tcFileName, m.ttCreated, m.llIWontUTF8, m.lcPassword, m.liCRC32)

Parameters:  

m.tcFileName

...

m.ttCreated

...

Code Block
Object.AppendFile(tcFilename [, tcNameInArchive [, llIWontUTF8 [, lcPassword]]]])


Code Block
titleXFRX 22.0
Object.AppendFile(tcFilename [, tcNameInArchive [, llIWontUTF8 [, lcPassword [, lcComment]]]]])


Code Block
titleXFRX 22.1
Object.AppendFile(tcFilename [, tcNameInArchive [, llIWontUTF8 [, lcPassword [, lcComment 
                 [, liLevel [, liMemLevel [, liStrategy [, liWBITS]]]]]]]])

Parameters   

tcFileName

   The source file name.

tcNameInArchive

    File name in ZIP archive. Default codepage is ANSI. If value of llIWontUTF8 parameter is TRUE, then string will be convert to  UTF-8.

llIWontUTF8
   A wish uses UTF-8 for encoding file name.

Info

For UTF-8

...

encoding  or

...

password is needy zlib.dll version 1.25 or higher.

...

lcPassword

  File password.

...

 

Return values
       0 - File append to ZIP archive.
  -102 - ZIP_PARAMERROR
  -103 - ZIP_BADZIPFILE
  -104 - ZIP_INTERNALERROR   

...

AppendFile()  

...

Add some file to ZIP archive.

Syntax:   

Code Block
eqZIP::AppendFile(m.tcFilename, m.tcNameInArchive, m.llIWontUTF8, m.lcPassword)

Parameters:    

m.tcFileName

   The source file name.

m.tcNameInArchive

    File name in ZIP archive. 

m.llIWontUTF8
   A wish uses UTF-8 for encoding file name.

Info

For UTF-8 encoding  or password is needy zlib.dll version 1.25 or higher.

m.lcPassword

  File password.

Return values 
  -1 - The source file doesn't exists 
  -2 - The source file cannot open
   0 - File append to ZIP archive 
  -102 - ZIP_PARAMERROR
  -103 - ZIP_BADZIPFILE
  -104 - ZIP_INTERNALERROR

...

WriteData()  

...

Write data to opened file handle. 

Syntax:  

Code Block
eqZIP::WriteData(m.tcData)

Parameters:  

m.tcData
   Data which will be write to file handle. 

Return values
  -102 - ZIP_PARAMERROR
  -103 - ZIP_BADZIPFILE
  -104 - ZIP_INTERNALERROR

...

CloseFile()  

Close file handle.

Syntax: 

Code Block
eqZIP::CloseFile()

...

SYS2007()

Calculate CRC32 checksum for data.

Syntax: 

Code Block
eqZIP::SYS2007(m.lcData)

Parameters:  

...

lcComment

 File comment. Default codepage is ANSI. If value of llIWontUTF8 parameter is TRUE, then string will be convert to  UTF-8.

liLevel

 Compression level. Allowed values are 1-9.

liMemLevel

 Memory level specifies how much memory should be allocated.

liStrategy

 Strategy specifies the compression algorithm. Allowed values are:

ValueDescription
0Default strategy
1Filtered data
2Huffman encoding
3RLE
4Fixed

liWBITS

 Specifies dictionar size in bits. Allowed values are 9..15.

Return values 

Number

ValueDescription
-1The source file doesn't exists. 
-2The source file cannot open.
-3The file is big (greather then 4GiB).
0File append to ZIP archive
-102Bad paremeters. (ZIP_PARAMERROR)
-103File is not a zip file. (ZIP_BADZIPFILE)
-104Internal at error at zipping data. (ZIP_INTERNALERROR)

Remarks

Applies To: XFRX#ZIP