OpenNewFile Method

Owned by martinajindrova
Last updated: May 29, 2023
2 min read

Open file handle.

Object.OpenNewFile(tcFileName [, ttCreated [, llIWontUTF8 
                   [, lcPassword, liCRC32]]])
XFRX 22.0
Object.OpenNewFile(tcFileName [, ttCreated [, llIWontUTF8 
                   [, lcPassword, liCRC32 [, llBIGFile [, lcComment]]]]])
XFRX 22.1
Object.OpenNewFile(tcFileName [, ttCreated [, llIWontUTF8 
                   [, lcPassword, liCRC32 [, llBIGFile
                   [, liLevel [, liMemLevel [, liStrategy [, liWBITS]]]]]]]])

Parameters

tcFileName

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

ttCreated

   Datetime created. 

llIWontUTF8

   A wish uses UTF-8 for encoding file name.

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

lcPassword

  File password.

liCRC32

  File CRC32 checksum. It is mandatory for lcPassword. Checksum is for all data.

llBIGFile

 Specifies if you want write data more then 4GiB.

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
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

See also

CloseFile Method
WriteData Method

Examples

LOCAL m.loZIP, m.lcZIPFile, m.lcFile
m.lcZIPFile="c:\temp\_big.zip"
m.loZIP =  EVALUATE([xfrx("XFRX#ZIP")])  
IF m.loZip.openArchive(m.lcZIPFile)

   m.lcData=SYS(0)+" "+TTOC(DATETIME())
   m.loZip.OpenNewFile("myFile") 
   m.loZip.WriteData(m.lcData) 
   m.loZip.CloseFile() 
   
   m.loZip.closearchive("ěščřžýáíé")
ENDIF
RELE m.loZIP