ZipEntry ActiveX Reference Documentation

ZipEntry

Current Version: 9.5.0.73

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

(Visual Basic 6.0)
Dim obj As New ChilkatZipEntry

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.ZipEntry")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.ZipEntry")

(Delphi)
obj := TChilkatZipEntry.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.ZipEntry')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.ZipEntry")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.ZipEntry', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.ZipEntry");

Properties

Comment
Comment As String

The comment stored within the Zip for this entry.

top
CompressedLength
CompressedLength As Long (read-only)

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

top
CompressedLengthStr
CompressedLengthStr As String (read-only)

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

top
CompressionLevel
CompressionLevel As Long

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

top
CompressionMethod
CompressionMethod As Long

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
Crc As Long (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
DebugLogFilePath As String

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
EncryptionKeyLen As Long (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
EntryID As Long (read-only)

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

top
EntryType
EntryType As Long (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.)

top
FileDateTime
FileDateTime As Date
This property is deprecated. It will be removed in a future version.

The local last-modified date/time.

top
FileDateTimeStr
FileDateTimeStr As String

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

top
FileName
FileName As String

The file name of the Zip entry.

top
FileNameHex
FileNameHex As String (read-only)

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

top
HeartbeatMs
HeartbeatMs As Long

The number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort inflate/extract/unzip calls prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

top
IsAesEncrypted
IsAesEncrypted As Long (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.

top
IsDirectory
IsDirectory As Long (read-only)

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

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
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 1. 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).

top
LastErrorHtml
LastErrorHtml As String (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.

top
LastErrorText
LastErrorText As String (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.

top
LastErrorXml
LastErrorXml As String (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.

top
LastMethodSuccess
LastMethodSuccess As Long
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
LastStringResult
LastStringResult As String (read-only)
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 1. 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).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

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

top
TextFlag
TextFlag As Long

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
UncompressedLength As Long (read-only)

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

top
UncompressedLengthStr
UncompressedLengthStr As String (read-only)

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

top
VerboseLogging
VerboseLogging As Long

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
Version As String (read-only)

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

top

Methods

AppendData
AppendData(inData As Variant) As Long

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

Returns 1 for success, 0 for failure.

top
AppendDataAsync (1) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
AppendDataAsync(inData As Variant) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
AppendString
AppendString(strContent As String, charset As String) As Long

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) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
AppendStringAsync(strContent As String, charset As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
Copy
Copy() As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

top
CopyToBase64
CopyToBase64() As 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 Nothing on failure

top
CopyToHex
CopyToHex() As 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 Nothing on failure

top
Extract
Extract(dirPath As String) As Long

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) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
ExtractAsync(dirPath As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
ExtractInto
ExtractInto(dirPath As String) As Long

Unzip a file into a specific directory

Returns 1 for success, 0 for failure.

top
ExtractIntoAsync (1) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
ExtractIntoAsync(dirPath As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
GetDt
GetDt() As CkDateTime

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

Returns Nothing on failure

top
Inflate
Inflate() As Variant

Inflate a file within a Zip directly into memory.

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

top
InflateAsync (1) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
InflateAsync() As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
NextEntry
NextEntry() As ChilkatZipEntry

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

Returns Nothing on failure

top
NextMatchingEntry
NextMatchingEntry(matchStr As String) As ChilkatZipEntry
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 Nothing on failure

top
ReplaceData
ReplaceData(inData As Variant) As Long

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

Returns 1 for success, 0 for failure.

top
ReplaceString
ReplaceString(strContent As String, charset As String) As Long

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.

top
SetDt
SetDt(dt As CkDateTime)

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

top
UnzipToBd
UnzipToBd(binData As ChilkatBinData) As Long
Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns 1 for success, 0 for failure.

top
UnzipToBdAsync (1) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
UnzipToBdAsync(binData As ChilkatBinData) As ChilkatTask
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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
UnzipToSb
UnzipToSb(ByVal lineEndingBehavior As Long, srcCharset As String, sb As ChilkatStringBuilder) As Long
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) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
UnzipToSbAsync(ByVal lineEndingBehavior As Long, srcCharset As String, sb As ChilkatStringBuilder) As ChilkatTask
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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
UnzipToStream
UnzipToStream(toStream As ChilkatStream) As Long
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.

top
UnzipToStreamAsync (1) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
UnzipToStreamAsync(toStream As ChilkatStream) As ChilkatTask
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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
UnzipToString
UnzipToString(ByVal lineEndingBehavior As Long, srcCharset As String) As 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 Nothing on failure

top
UnzipToStringAsync (1) (2) (Classic ASP) (Visual FoxPro) (PowerBuilder) (SQL Server) (Visual Basic 6.0) (VBScript)
UnzipToStringAsync(ByVal lineEndingBehavior As Long, srcCharset As String) As ChilkatTask

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top

Events

AbortCheck
AbortCheck(abort As Long)

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myZipentry As ChilkatZipEntry

Private Sub myZipentry_ENTRY_NAME(abort As Long)

	'Insert application code here.

End Sub
top
PercentDone
PercentDone(ByVal pctDone As Long, abort As Long)

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myZipentry As ChilkatZipEntry

Private Sub myZipentry_ENTRY_NAME(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub
top
ProgressInfo
ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myZipentry As ChilkatZipEntry

Private Sub myZipentry_ENTRY_NAME(name As String, value As String)

	'Insert application code here.

End Sub
top