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

obj.i = CkZipEntry::ckCreate()

; Make sure to dispose of the object when finished like this:
CkZipEntry::ckDispose(obj);

Properties

Declare.s ckComment(obj.i)
Declare setCkComment(obj.i, value.s)

The comment stored within the Zip for this entry.

Declare.i ckCompressedLength(obj.i) ; (read-only)

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

Declare.i ckCompressedLength64(obj.i) ; (read-only)

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

Declare.i ckCompressionLevel(obj.i)
Declare setCkCompressionLevel(obj.i, value.i)

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

Declare.i ckCompressionMethod(obj.i)
Declare setCkCompressionMethod(obj.i, value.i)

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

Declare.i ckCrc(obj.i) ; (read-only)

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 )

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

Declare.i ckEncryptionKeyLen(obj.i) ; (read-only)

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.

Declare.i ckEntryID(obj.i) ; (read-only)

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

Declare.i ckEntryType(obj.i) ; (read-only)

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

Declare.s ckFileDateTimeStr(obj.i)
Declare setCkFileDateTimeStr(obj.i, value.s)

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

Declare.s ckFileName(obj.i)
Declare setCkFileName(obj.i, value.s)

The file name of the Zip entry.

Set Entry Filepath (in output Zip) when Zipping

Declare.s ckFileNameHex(obj.i) ; (read-only)

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

Declare.i ckIsAesEncrypted(obj.i) ; (read-only)

Introduced in version 9.5.0.69

1 if the entry is AES encrypted. This property can only be 1 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 0 if the entry contained in the zip is not AES encrypted.

Declare.i ckIsDirectory(obj.i) ; (read-only)

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

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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.

Declare.s ckLastErrorText(obj.i) ; (read-only)

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

Declare.s ckLastErrorXml(obj.i) ; (read-only)

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.

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Declare.i ckTextFlag(obj.i)
Declare setCkTextFlag(obj.i, value.i)

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.

Declare.i ckUncompressedLength(obj.i) ; (read-only)

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

Declare.i ckUncompressedLength64(obj.i) ; (read-only)

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

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

Declare.s ckVersion(obj.i) ; (read-only)

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

Methods

Declare.i ckAppendString(obj.i, strContent.s, charset.s)

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 1 for success, 0 for failure.

Declare.i ckAppendStringAsync(obj.i, strContent.s, charset.s)

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 0 on failure

How to Run an Asynchronous Task

Declare.s ckCopyToBase64(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckCopyToHex(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckExtract(obj.i, dirPath.s)

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 1 for success, 0 for failure.

Declare.i ckExtractAsync(obj.i, dirPath.s)

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 0 on failure

How to Run an Asynchronous Task

Declare.i ckExtractInto(obj.i, dirPath.s)

Unzip a file into a specific directory

Returns 1 for success, 0 for failure.

Declare.i ckExtractIntoAsync(obj.i, dirPath.s)

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 0 on failure

How to Run an Asynchronous Task

Declare.i ckGetDt(obj.i)

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

Returns 0 on failure

Declare.i ckNextEntry(obj.i)

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

Returns 0 on failure

Declare.i ckNextMatchingEntry(obj.i, matchStr.s)

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 0 on failure

Iterate over Matching Filenames

Declare.i ckReplaceString(obj.i, strContent.s, charset.s)

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 1 for success, 0 for failure.

Replace/Update a FIle in a .zip

Declare.i ckSaveLastError(obj.i, path.s)

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

Declare ckSetDt(obj.i, dt.i)

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

Declare.i ckUnzipToBd(obj.i, binData.i)

Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns 1 for success, 0 for failure.

Declare.i ckUnzipToBdAsync(obj.i, binData.i)

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 0 on failure

How to Run an Asynchronous Task

Declare.i ckUnzipToSb(obj.i, lineEndingBehavior.l, srcCharset.s, sb.i)

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 1 for success, 0 for failure.

Declare.i ckUnzipToSbAsync(obj.i, lineEndingBehavior.l, srcCharset.s, sb.i)

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 0 on failure

How to Run an Asynchronous Task

Declare.i ckUnzipToStream(obj.i, toStream.i)

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 1 for success, 0 for failure.

Unzip Binary File to Stream

Declare.i ckUnzipToStreamAsync(obj.i, toStream.i)

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 0 on failure

Unzip One File to a Stream

Declare.s ckUnzipToString(obj.i, lineEndingBehavior.l, srcCharset.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Iterate over Matching Filenames

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

Declare.i ckUnzipToStringAsync(obj.i, lineEndingBehavior.l, srcCharset.s)

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 0 on failure

How to Run an Asynchronous Task