ZipEntry DataFlex Reference Documentation

ZipEntry

Represents a single file or directory entry within a Chilkat Zip object. A zip entry can be one of 5 types (see the description of the EntryType property below).

Object Creation

Handle hoZipEntry
Get Create(RefClass(cComChilkatZipEntry)) to hoZipEntry

Properties

Function ComComment Returns String
Procedure Set ComComment String value

The comment stored within the Zip for this entry.

Function ComCompressedLength Returns Integer

The size in bytes of this entry's file data when compression is applied

Function ComCompressedLengthStr Returns String

The size in decimal string format of this file when Zip compression is applied.

Function ComCompressionLevel Returns Integer
Procedure Set ComCompressionLevel Integer value

The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.

Function ComCompressionMethod Returns Integer
Procedure Set ComCompressionMethod Integer value

Set to 0 for no compression, or 8 for the Deflate algorithm. The Deflate algorithm is the default algorithm of the most popular Zip utility programs, such as WinZip

Function ComCrc Returns Integer

The CRC for the zip entry. For AES encrypted entries, the CRC value will be 0. (See http://www.winzip.com/aes_info.htm#CRC )

Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

Function ComEncryptionKeyLen Returns Integer

Introduced in version 9.5.0.69

If this entry is AES encrypted, then this property contains the AES key length (128, 192, or 256). If the entry is not AES encrypted, then the value is 0.

Function ComEntryID Returns Integer

The unique ID assigned by Zip.NET while the object is instantiated in memory.

Function ComEntryType Returns Integer

Indicates the origin of the entry. There are three possible values:

  1. Mapped Entry: An entry in an existing Zip file.
  2. File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
  3. Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
  4. Null Entry: An entry that no longer exists in the .zip.
  5. New Directory Entry: A directory entry added by calling AppendNewDir.
When the zip is written by calling WriteZip or WriteToMemory, all of the zip entries are transformed into mapped entries. They become entries that contain the compressed data within the .zip that was just created. (The WriteZip method call effectively writes the zip and then opens it, replacing all of the existing entries with mapped entries.)

Function ComFileDateTime Returns DateTime
Procedure Set ComFileDateTime DateTime value

This property is deprecated. It will be removed in a future version.

The local last-modified date/time.

Function ComFileDateTimeStr Returns String
Procedure Set ComFileDateTimeStr String value

The local last-modified date/time in RFC822 string format.

Function ComFileName Returns String
Procedure Set ComFileName String value

The file name of the Zip entry.

Set Entry Filepath (in output Zip) when Zipping

Function ComFileNameHex Returns String

A string containing the hex encoded raw filename bytes found in the Zip entry.

Function ComIsAesEncrypted Returns Boolean

Introduced in version 9.5.0.69

True if the entry is AES encrypted. This property can only be True for entries already contained in a .zip (i.e. entries obtained from a zip archive that was opened via OpenZip, OpenBd, OpenFromMemory, etc.) The property is False if the entry contained in the zip is not AES encrypted.

Function ComIsDirectory Returns Boolean

True if the Zip entry is a directory, false if it is a file.

Function ComLastBinaryResult Returns Variant

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

Function ComLastErrorHtml Returns String

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Function ComLastErrorText Returns String

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

Function ComLastErrorXml Returns String

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Function ComLastStringResult Returns String

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

Function ComLastStringResultLen Returns Integer

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

Function ComTextFlag Returns Boolean
Procedure Set ComTextFlag Boolean value

Controls whether the "text flag" of the internal file attributes for this entry within the zip is set. This is a bit flag that indicates whether the file contents are text or binary. It is for informational use and it is not imperative that this bit flag is accurately set. The ability to set this bit flag is only provided to satisfy certain cases where another application might be sensitive to the flag.

Function ComUncompressedLength Returns Integer

The size in bytes of this entry's file data when uncompressed.

Function ComUncompressedLengthStr Returns String

The size in bytes (in decimal string format) of this zip entry's data when uncompressed.

Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Function ComVersion Returns String

Version of the component/library, such as "9.5.0.63"

Methods

Function ComAppendData Variant inData Returns Boolean

Appends binary data to the zip entry's file contents.

Returns True for success, False for failure.

Function ComAppendDataAsync Variant inData Returns cComChilkatTask

Creates an asynchronous task to call the AppendData method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Function ComAppendString String strContent String charset Returns Boolean

Appends text data to the zip entry's file contents. The text is appended using the character encoding specified by the charset, which can be "utf-8", "ansi", etc.

Returns True for success, False for failure.

Function ComAppendStringAsync String strContent String charset Returns cComChilkatTask

Creates an asynchronous task to call the AppendString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Function ComCopy Returns Variant

Returns the compressed data as a byte array.

Note: The Copy method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry"). This is the case when an existing .zip is opened (from memory or from a file), or after the .zip has been written (by calling WriteZip or WriteToMemory). If a zip entry is created via AppendData, AppendFiles, etc., then it does not yet contain compressed data. When the zip is written, each entry becomes a "mapped entry" (The value of the EntryType property becomes 0.)

Returns null on failure

Function ComCopyToBase64 Returns String

Returns the compressed data as a Base64-encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.

Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry").

Returns null on failure

Function ComCopyToHex Returns String

Returns the compressed data as a hexidecimal encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.

Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry").

Returns null on failure

Function ComExtract String dirPath Returns Boolean

Unzips this entry into the specified base directory. The file is unzipped to the subdirectory according to the relative path stored with the entry in the Zip. Use ExtractInto to unzip into a specific directory regardless of the path information stored in the Zip.

Returns True for success, False for failure.

Function ComExtractAsync String dirPath Returns cComChilkatTask

Creates an asynchronous task to call the Extract method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Function ComExtractInto String dirPath Returns Boolean

Unzip a file into a specific directory

Returns True for success, False for failure.

Function ComExtractIntoAsync String dirPath Returns cComChilkatTask

Creates an asynchronous task to call the ExtractInto method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Function ComGetDt Returns cComCkDateTime

Returns the last-modified date/time of this zip entry.

Returns null on failure

Function ComInflate Returns Variant

Inflate a file within a Zip directly into memory.

Returns null on failure

Function ComInflateAsync Returns cComChilkatTask

Creates an asynchronous task to call the Inflate method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Function ComNextEntry Returns cComChilkatZipEntry

Return the next entry (file or directory) within the Zip

Returns null on failure

Function ComNextMatchingEntry String matchStr Returns cComChilkatZipEntry

Introduced in version 9.5.0.50

Returns the next entry having a filename matching the matchStr. The "*" characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern.

Returns null on failure

Iterate over Matching Filenames

Function ComReplaceData Variant inData Returns Boolean

Replaces the zip entry's existing contents with new data.

Returns True for success, False for failure.

Function ComReplaceString String strContent String charset Returns Boolean

Replaces the zip entry's existing contents with new text data. The text will be stored using the character encoding as specified by charset, which can be "utf-8", "ansi", etc.

Returns True for success, False for failure.

Replace/Update a FIle in a .zip

Procedure ComSetDt cComCkDateTime dt

Sets the last-modified date/time for this zip entry.

Function ComUnzipToBd cComChilkatBinData binData Returns Boolean

Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns True for success, False for failure.

Function ComUnzipToBdAsync cComChilkatBinData binData Returns cComChilkatTask

Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Function ComUnzipToSb Integer lineEndingBehavior String srcCharset cComChilkatStringBuilder sb Returns Boolean

Introduced in version 9.5.0.67

Unzips a text file to the sb. The contents of sb are appended with the unzipped file. The lineEndingBehavior is as follows:

0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's

The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.

Returns True for success, False for failure.

Function ComUnzipToSbAsync Integer lineEndingBehavior String srcCharset cComChilkatStringBuilder sb Returns cComChilkatTask

Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task

Function ComUnzipToStream cComChilkatStream toStream Returns Boolean

Introduced in version 9.5.0.67

Unzips a file within a Zip to a stream. If called synchronously, the toStream must have a sink, such as a file or another stream object. If called asynchronously, then the foreground thread can read the stream.

Returns True for success, False for failure.

Unzip Binary File to Stream

Function ComUnzipToStreamAsync cComChilkatStream toStream Returns cComChilkatTask

Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToStream method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

Unzip One File to a Stream

Function ComUnzipToString Integer lineEndingBehavior String srcCharset Returns String

Inflate and return the uncompressed data as a string The lineEndingBehavior is as follows:

0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's

The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.

Returns null on failure

Iterate over Matching Filenames

Download a Zip from a URL and OpenFromMemory. (No .zip fie is created)

Function ComUnzipToStringAsync Integer lineEndingBehavior String srcCharset Returns cComChilkatTask

Creates an asynchronous task to call the UnzipToString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

How to Run an Asynchronous Task