ZipEntry JavaScript Reference Documentation

ZipEntry

Current Version: 11.4.0

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

Note: This is intended for running within a Chilkat.Js embedded JavaScript engine.

var obj = new CkZipEntry();

Properties

Comment

· string

The comment stored within the Zip for this entry.

top

CompressedLength

· unsigned int, read-only

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

top

CompressedLength64

· int64, read-only

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

top

CompressedLengthStr

· string, read-only

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

top

CompressionLevel

· int

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

top

CompressionMethod

· int

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

· int, 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 )

top

DebugLogFilePath

· string

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

top

EncryptionKeyLen

· int, 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.

top

EntryID

· int, read-only

A unique ID assigned to the entry while the object is instantiated in memory.

top

EntryType

· int, read-only

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

Mapped Entry: An entry in an existing Zip file.
File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
Null Entry: An entry that no longer exists in the .zip.
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.)

More Information and Examples

Zip Append Files and Entry Type

top

FileDateTimeStr

· string

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

top

FileName

· string

The file name of the Zip entry.

More Information and Examples

Set Entry Filepath (in output Zip) when Zipping

top

FileNameHex

· string, read-only

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

top

IsAesEncrypted

· boolean, read-only

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.

top

IsDirectory

· boolean, read-only

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

top

LastErrorHtml

· string, read-only

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top

LastErrorText

· string, read-only

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

top

LastErrorXml

· string, read-only

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top

LastMethodSuccess

· boolean

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top

TextFlag

· boolean

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 int, read-only

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

top

UncompressedLength64

· int64, read-only

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

top

UncompressedLengthStr

· string, read-only

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

top

VerboseLogging

· boolean

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.

top

Version

· string, read-only

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

More Information and Examples

How to get the Chilkat version at runtime.

top

Methods

AppendString

var success = AppendString(strContent, charset);

· return: boolean; true for success, false for failure
· strContent: string
· charset: string

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.

top

CopyToBase64

var strVal = CopyToBase64();

· return: 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

top

CopyToHex

var strVal = CopyToHex();

· return: 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

top

Extract

var success = Extract(dirPath);

· return: boolean; true for success, false for failure
· dirPath: string

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.

top

ExtractInto

var success = ExtractInto(dirPath);

· return: boolean; true for success, false for failure
· dirPath: string

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 true for success, false for failure.

top

GetNext

var success = GetNext();

· return: boolean; true for success, false for failure

Introduced in version 11.0.0

Updates this object to the next entry (file or directory) within this zip.

Returns true for success, false for failure.

top

GetNextMatch

var success = GetNextMatch(pattern);

· return: boolean; true for success, false for failure
· pattern: string

Introduced in version 11.0.0

Updates this object to the next matching entry (file or directory) within this zip. The * characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern.

Returns true for success, false for failure.

top

ReplaceString

var success = ReplaceString(strContent, charset);

· return: boolean; true for success, false for failure
· strContent: string
· charset: string

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.

More Information and Examples

Replace/Update a FIle in a .zip

top

SetDt

SetDt(dt);

· return: undefined
· dt: CkDateTime

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

top

UnzipToBd

var success = UnzipToBd(binData);

· return: boolean; true for success, false for failure
· binData: CkBinData

Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns true for success, false for failure.

top

UnzipToSb

var success = UnzipToSb(lineEndingBehavior, srcCharset, sb);

· return: boolean; true for success, false for failure
· lineEndingBehavior: int
· srcCharset: string
· sb: CkStringBuilder

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.

top

UnzipToString

var strVal = UnzipToString(lineEndingBehavior, srcCharset);

· return: string
· lineEndingBehavior: int
· srcCharset: 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

More Information and Examples

Iterate over Matching Filenames Download a Zip from a URL and OpenFromMemory. (No .zip fie is created)

top