ZipEntry Tcl Reference Documentation

ZipEntry

Current Version: 9.5.0.75

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

set myZipEntry [new CkZipEntry]

Properties

Comment
string
# ckStr is a CkString
CkZipEntry_get_Comment $myZipEntry $ckStr
set strVal [CkZipEntry_get_comment $myZipEntry]
CkZipEntry_put_Comment $myZipEntry $strVal

The comment stored within the Zip for this entry.

top
CompressedLength
unsigned integer
set intVal [CkZipEntry_get_CompressedLength $myZipEntry]

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

top
CompressedLength64
(64-bit integer)
set int64Val [CkZipEntry_get_CompressedLength64 $myZipEntry]

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

top
CompressedLengthStr
string
# ckStr is a CkString
CkZipEntry_get_CompressedLengthStr $myZipEntry $ckStr
set strVal [CkZipEntry_get_compressedLengthStr $myZipEntry]

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

top
CompressionLevel
integer
set intVal [CkZipEntry_get_CompressionLevel $myZipEntry]
CkZipEntry_put_CompressionLevel $myZipEntry $intVal

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

top
CompressionMethod
integer
set intVal [CkZipEntry_get_CompressionMethod $myZipEntry]
CkZipEntry_put_CompressionMethod $myZipEntry $intVal

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

top
Crc
integer
set intVal [CkZipEntry_get_Crc $myZipEntry]

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 )

top
DebugLogFilePath
string
# ckStr is a CkString
CkZipEntry_get_DebugLogFilePath $myZipEntry $ckStr
set strVal [CkZipEntry_get_debugLogFilePath $myZipEntry]
CkZipEntry_put_DebugLogFilePath $myZipEntry $strVal

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.

top
EncryptionKeyLen
integer
set intVal [CkZipEntry_get_EncryptionKeyLen $myZipEntry]
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.

top
EntryID
integer
set intVal [CkZipEntry_get_EntryID $myZipEntry]

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

top
EntryType
integer
set intVal [CkZipEntry_get_EntryType $myZipEntry]

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

top
FileDateTimeStr
string
# ckStr is a CkString
CkZipEntry_get_FileDateTimeStr $myZipEntry $ckStr
set strVal [CkZipEntry_get_fileDateTimeStr $myZipEntry]
CkZipEntry_put_FileDateTimeStr $myZipEntry $strVal

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

top
FileName
string
# ckStr is a CkString
CkZipEntry_get_FileName $myZipEntry $ckStr
set strVal [CkZipEntry_get_fileName $myZipEntry]
CkZipEntry_put_FileName $myZipEntry $strVal

The file name of the Zip entry.

top
FileNameHex
string
# ckStr is a CkString
CkZipEntry_get_FileNameHex $myZipEntry $ckStr
set strVal [CkZipEntry_get_fileNameHex $myZipEntry]

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

top
IsAesEncrypted
boolean 1/0
set boolVal [CkZipEntry_get_IsAesEncrypted $myZipEntry]
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.

top
IsDirectory
boolean 1/0
set boolVal [CkZipEntry_get_IsDirectory $myZipEntry]

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

top
LastErrorHtml
string
# ckStr is a CkString
CkZipEntry_get_LastErrorHtml $myZipEntry $ckStr
set strVal [CkZipEntry_get_lastErrorHtml $myZipEntry]

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.

top
LastErrorText
string
# ckStr is a CkString
CkZipEntry_get_LastErrorText $myZipEntry $ckStr
set strVal [CkZipEntry_get_lastErrorText $myZipEntry]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkZipEntry_get_LastErrorXml $myZipEntry $ckStr
set strVal [CkZipEntry_get_lastErrorXml $myZipEntry]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkZipEntry_get_LastMethodSuccess $myZipEntry]
CkZipEntry_put_LastMethodSuccess $myZipEntry $boolVal
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.

top
TextFlag
boolean 1/0
set boolVal [CkZipEntry_get_TextFlag $myZipEntry]
CkZipEntry_put_TextFlag $myZipEntry $boolVal

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.

top
UncompressedLength
unsigned integer
set intVal [CkZipEntry_get_UncompressedLength $myZipEntry]

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

top
UncompressedLength64
(64-bit integer)
set int64Val [CkZipEntry_get_UncompressedLength64 $myZipEntry]

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

top
UncompressedLengthStr
string
# ckStr is a CkString
CkZipEntry_get_UncompressedLengthStr $myZipEntry $ckStr
set strVal [CkZipEntry_get_uncompressedLengthStr $myZipEntry]

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

top
Utf8
boolean 1/0
set boolVal [CkZipEntry_get_Utf8 $myZipEntry]
CkZipEntry_put_Utf8 $myZipEntry $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkZipEntry_get_VerboseLogging $myZipEntry]
CkZipEntry_put_VerboseLogging $myZipEntry $boolVal

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.

top
Version
string
# ckStr is a CkString
CkZipEntry_get_Version $myZipEntry $ckStr
set strVal [CkZipEntry_get_version $myZipEntry]

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

top

Methods

AppendData
# inData is a CkByteData
set status [CkZipEntry_AppendData $inData]

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

Returns 1 for success, 0 for failure.

top
AppendDataAsync (1)
# returns a CkTask
# inData is a CkByteData
set ret_task [CkZipEntry_AppendDataAsync $inData]

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

top
AppendString
# strContent is a string
# charset is a string
set status [CkZipEntry_AppendString $strContent $charset]

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.

top
AppendStringAsync (1)
# returns a CkTask
# strContent is a string
# charset is a string
set ret_task [CkZipEntry_AppendStringAsync $strContent $charset]

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

top
Copy
# outData is a CkByteData (output)
set status [CkZipEntry_Copy $outData]

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

top
CopyToBase64
# outStr is a CkString (output)
set status [CkZipEntry_CopyToBase64 $outStr]
set retStr [CkZipEntry_copyToBase64 $myZipEntry]

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

top
CopyToHex
# outStr is a CkString (output)
set status [CkZipEntry_CopyToHex $outStr]
set retStr [CkZipEntry_copyToHex $myZipEntry]

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

top
Extract
# dirPath is a string
set status [CkZipEntry_Extract $dirPath]

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.

top
ExtractAsync (1)
# returns a CkTask
# dirPath is a string
set ret_task [CkZipEntry_ExtractAsync $dirPath]

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

top
ExtractInto
# dirPath is a string
set status [CkZipEntry_ExtractInto $dirPath]

Unzip a file into a specific directory. If this entry is a directory, then nothing occurs. (An application can check the IsDirectory property and instead call Extract if it is desired to create the directory.)

Returns 1 for success, 0 for failure.

top
ExtractIntoAsync (1)
# returns a CkTask
# dirPath is a string
set ret_task [CkZipEntry_ExtractIntoAsync $dirPath]

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

top
GetDt
# returns a CkDateTime
set ret_ckDateTime [CkZipEntry_GetDt]

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

Returns NULL on failure

top
Inflate
# outData is a CkByteData (output)
set status [CkZipEntry_Inflate $outData]

Inflate a file within a Zip directly into memory.

Returns 1 for success, 0 for failure.

top
InflateAsync (1)
# returns a CkTask
set ret_task [CkZipEntry_InflateAsync]

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

top
NextEntry
# returns a CkZipEntry
set ret_zipEntry [CkZipEntry_NextEntry]

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

Returns NULL on failure

top
NextMatchingEntry
# matchStr is a string
set status [CkZipEntry_NextMatchingEntry $matchStr]
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

More Information and Examples
top
ReplaceData
# inData is a CkByteData
set status [CkZipEntry_ReplaceData $inData]

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

Returns 1 for success, 0 for failure.

top
ReplaceString
# strContent is a string
# charset is a string
set status [CkZipEntry_ReplaceString $strContent $charset]

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.

More Information and Examples
top
SaveLastError
# path is a string
set status [CkZipEntry_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

top
SetDt
# dt is a CkDateTime
CkZipEntry_SetDt $dt

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

top
UnzipToBd
# binData is a CkBinData
set status [CkZipEntry_UnzipToBd $binData]
Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns 1 for success, 0 for failure.

top
UnzipToBdAsync (1)
# returns a CkTask
# binData is a CkBinData
set ret_task [CkZipEntry_UnzipToBdAsync $binData]
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

top
UnzipToSb
# lineEndingBehavior is an integer
# srcCharset is a string
# sb is a CkStringBuilder
set status [CkZipEntry_UnzipToSb $lineEndingBehavior $srcCharset $sb]
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.

top
UnzipToSbAsync (1)
# returns a CkTask
# lineEndingBehavior is an integer
# srcCharset is a string
# sb is a CkStringBuilder
set ret_task [CkZipEntry_UnzipToSbAsync $lineEndingBehavior $srcCharset $sb]
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

top
UnzipToStream
# toStream is a CkStream
set status [CkZipEntry_UnzipToStream $toStream]
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.

More Information and Examples
top
UnzipToStreamAsync (1)
# returns a CkTask
# toStream is a CkStream
set ret_task [CkZipEntry_UnzipToStreamAsync $toStream]
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

More Information and Examples
top
UnzipToString
# lineEndingBehavior is an integer
# srcCharset is a string
# outStr is a CkString (output)
set status [CkZipEntry_UnzipToString $lineEndingBehavior $srcCharset $outStr]
set retStr [CkZipEntry_unzipToString $myZipEntry $lineEndingBehavior $srcCharset]

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

top
UnzipToStringAsync (1)
# returns a CkTask
# lineEndingBehavior is an integer
# srcCharset is a string
set ret_task [CkZipEntry_UnzipToStringAsync $lineEndingBehavior $srcCharset]

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

top