ZipEntry VB.NET Reference Documentation

ZipEntry

Current Version: 11.0.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

Dim obj As New Chilkat.ZipEntry()

Properties

Comment
Comment As String

The comment stored within the Zip for this entry.

top
CompressedLength
CompressedLength As UInteger (ReadOnly)

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

top
CompressedLength64
CompressedLength64 As Int64 (ReadOnly)

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

top
CompressedLengthStr
CompressedLengthStr As String (ReadOnly)

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

top
CompressionLevel
CompressionLevel As Integer

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

top
CompressionMethod
CompressionMethod As Integer

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 Integer (ReadOnly)

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, 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
top
EncryptionKeyLen
EncryptionKeyLen As Integer (ReadOnly)
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 Integer (ReadOnly)

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

top
EntryType
EntryType As Integer (ReadOnly)

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

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

More Information and Examples
top
FileDateTime
FileDateTime As Date

The entry's 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 (ReadOnly)

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

top
HeartbeatMs
HeartbeatMs As Integer

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.

More Information and Examples
top
IsAesEncrypted
IsAesEncrypted As Boolean (ReadOnly)
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
IsDirectory As Boolean (ReadOnly)

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

top
LastErrorHtml
LastErrorHtml As String (ReadOnly)

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
LastErrorText As String (ReadOnly)

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.

top
LastErrorXml
LastErrorXml As String (ReadOnly)

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
LastMethodSuccess As 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.

top
TextFlag
TextFlag As 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
UncompressedLength As UInteger (ReadOnly)

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

top
UncompressedLength64
UncompressedLength64 As Int64 (ReadOnly)

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

top
UncompressedLengthStr
UncompressedLengthStr As String (ReadOnly)

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

top
VerboseLogging
VerboseLogging As 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
Version As String (ReadOnly)

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

More Information and Examples
top

Methods

AppendData
Function AppendData(ByVal inData As Byte()) As Boolean

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

Returns True for success, False for failure.

top
AppendDataAsync (1)
Function AppendDataAsync(ByVal inData As Byte()) As Task

Creates an asynchronous task to call the AppendData method with the arguments provided.

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
Function AppendString(ByVal strContent As String, ByVal charset As String) As 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.

top
AppendStringAsync (1)
Function AppendStringAsync(ByVal strContent As String, ByVal charset As String) As Task

Creates an asynchronous task to call the AppendString method with the arguments provided.

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
Function Copy() As Byte()

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 an empty byte array on failure

top
CopyToBase64
Function 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
Function 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
Function Extract(ByVal dirPath As String) As 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.

top
ExtractAsync (1)
Function ExtractAsync(ByVal dirPath As String) As Task

Creates an asynchronous task to call the Extract method with the arguments provided.

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
Function ExtractInto(ByVal dirPath As String) As Boolean

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
ExtractIntoAsync (1)
Function ExtractIntoAsync(ByVal dirPath As String) As Task

Creates an asynchronous task to call the ExtractInto method with the arguments provided.

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
GetNext
Function GetNext() As Boolean
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
Function GetNextMatch(ByVal pattern As String) As Boolean
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
Inflate
Function Inflate() As Byte()

Inflate a file within a Zip directly into memory.

Returns an empty byte array on failure

More Information and Examples
top
InflateAsync (1)
Function InflateAsync() As Task

Creates an asynchronous task to call the Inflate method with the arguments provided.

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
LoadTaskCaller
Function LoadTaskCaller(ByVal task As Task) As Boolean
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

top
ReplaceData
Function ReplaceData(ByVal inData As Byte()) As Boolean

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

Returns True for success, False for failure.

top
ReplaceString
Function ReplaceString(ByVal strContent As String, ByVal charset As String) As 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.

More Information and Examples
top
SetDt
Sub SetDt(ByVal dt As CkDateTime)

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

top
UnzipToBd
Function UnzipToBd(ByVal binData As BinData) As Boolean
Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns True for success, False for failure.

top
UnzipToBdAsync (1)
Function UnzipToBdAsync(ByVal binData As BinData) As Task
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToBd method with the arguments provided.

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
Function UnzipToSb(ByVal lineEndingBehavior As Integer, ByVal srcCharset As String, ByVal sb As StringBuilder) As 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.

top
UnzipToSbAsync (1)
Function UnzipToSbAsync(ByVal lineEndingBehavior As Integer, ByVal srcCharset As String, ByVal sb As StringBuilder) As Task
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToSb method with the arguments provided.

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
Function UnzipToStream(ByVal toStream As Stream) As 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.

More Information and Examples
top
UnzipToStreamAsync (1)
Function UnzipToStreamAsync(ByVal toStream As Stream) As Task
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UnzipToStream method with the arguments provided.

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

More Information and Examples
top
UnzipToString
Function UnzipToString(ByVal lineEndingBehavior As Integer, ByVal 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)
Function UnzipToStringAsync(ByVal lineEndingBehavior As Integer, ByVal srcCharset As String) As Task

Creates an asynchronous task to call the UnzipToString method with the arguments provided.

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
Event OnAbortCheck

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

More Information and Examples

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

Dim WithEvents zipentry As Chilkat.ZipEntry

Private Sub zipentry_OnAbortCheck(sender As Object, args As Chilkat.AbortCheckEventArgs) Handles zipentry.OnAbortCheck

    ...

End Sub
top
PercentDone
Event OnPercentDone

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to True. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

Dim WithEvents zipentry As Chilkat.ZipEntry

Private Sub zipentry_OnPercentDone(sender As Object, args As Chilkat.PercentDoneEventArgs) Handles zipentry.OnPercentDone

    ...

End Sub
top
ProgressInfo
Event OnProgressInfo

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

Dim WithEvents zipentry As Chilkat.ZipEntry

Private Sub zipentry_OnProgressInfo(sender As Object, args As Chilkat.ProgressInfoEventArgs) Handles zipentry.OnProgressInfo

    ...

End Sub
top
TaskCompleted
Event OnTaskCompleted

Called from the background thread when an asynchronous task completes.

More Information and Examples

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

Dim WithEvents zipentry As Chilkat.ZipEntry

Private Sub zipentry_OnTaskCompleted(sender As Object, args As Chilkat.TaskCompletedEventArgs) Handles zipentry.OnTaskCompleted

    ...

End Sub
top

Deprecated

GetDt
Function GetDt() As CkDateTime
This method is deprecated.

This method is deprecated and will be removed in a future version. Use the FileDateTimeStr property instead. Returns the last-modified date/time of this zip entry.

Returns Nothing on failure

top
NextEntry
Function NextEntry() As ZipEntry
This method is deprecated and replaced by GetNext

This method is deprecated. Applications should instead call GetNext.

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

Returns Nothing on failure

top
NextMatchingEntry
Function NextMatchingEntry(ByVal matchStr As String) As ZipEntry
Introduced in version 9.5.0.50
This method is deprecated and replaced by GetNextMatch

This method is deprecated. Applications should instead call GetNextMatch.

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

Returns Nothing on failure

More Information and Examples
top