ZipEntry C# 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
Chilkat.ZipEntry obj = new Chilkat.ZipEntry();
Properties
Comment
The comment stored within the Zip for this entry.
topCompressedLength
The size in bytes of this entry's file data when compression is applied
topCompressedLength64
The size in bytes of this entry's file data when compression is applied
topCompressedLengthStr
The size in decimal string format of this file when Zip compression is applied.
topCompressionLevel
The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.
topCompressionMethod
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
topCrc
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 )
topDebugLogFilePath
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.
EncryptionKeyLen
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.
topEntryID
A unique ID assigned to the entry while the object is instantiated in memory.
topEntryType
Indicates the origin of the entry. There are three possible values:
- 0>
- 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.
FileDateTime
The entry's last-modified date/time.
topFileDateTimeStr
The local last-modified date/time in RFC822 string format.
topFileName
FileNameHex
A string containing the hex encoded raw filename bytes found in the Zip entry.
topHeartbeatMs
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.
IsAesEncrypted
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.
IsDirectory
True if the Zip entry is a directory, false if it is a file.
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
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.
TextFlag
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.
UncompressedLength
The size in bytes of this entry's file data when uncompressed.
topUncompressedLength64
The size in bytes of this entry's file data when uncompressed.
topUncompressedLengthStr
The size in bytes (in decimal string format) of this zip entry's data when uncompressed.
topVerboseLogging
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.
Version
Methods
AppendData
Appends binary data to the zip entry's file contents.
Returns true for success, false for failure.
topAppendDataAsync (C#) (PowerShell)
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 null on failure
AppendString
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.
topAppendStringAsync (C#) (PowerShell)
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 null on failure
Copy
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
topCopyToBase64
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
CopyToHex
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
Extract
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.
topExtractAsync (C#) (PowerShell)
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 null on failure
ExtractInto
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.
topExtractIntoAsync (C#) (PowerShell)
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 null on failure
GetNext
Updates this object to the next entry (file or directory) within this zip.
Returns true for success, false for failure.
topGetNextMatch
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.
topInflate
Inflate a file within a Zip directly into memory.
Returns an empty byte array on failure
InflateAsync (C#) (PowerShell)
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 null on failure
LoadTaskCaller
ReplaceData
Replaces the zip entry's existing contents with new data.
Returns true for success, false for failure.
topReplaceString
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.
SetDt
Sets the last-modified date/time for this zip entry.
topUnzipToBd
UnzipToBdAsync (C#) (PowerShell)
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 null on failure
UnzipToSb
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.
topUnzipToSbAsync (C#) (PowerShell)
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 null on failure
UnzipToStream
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.
UnzipToStreamAsync (C#) (PowerShell)
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 null on failure
UnzipToString
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
UnzipToStringAsync (C#) (PowerShell)
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 null on failure
Events
AbortCheck
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.
Chilkat .NET Framework Event Implementation
Args are passed using Chilkat.AbortCheckEventArgs
Event callback implementation:
private void zipentry_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); zipentry.OnAbortCheck += zipentry_OnAbortCheck;
Chilkat .NET Core Event Implementation
Event callback implementation:
public void handleAbortCheck(out bool abort)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); // ... Chilkat.ZipEntry.AbortCheck abortCheck = new Chilkat.ZipEntry.AbortCheck(handleAbortCheck); zipentry.setAbortCheckCb(abortCheck);
PercentDone
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.
Chilkat .NET Framework Event Implementation
Args are passed using Chilkat.PercentDoneEventArgs
Event callback implementation:
private void zipentry_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); zipentry.OnPercentDone += zipentry_OnPercentDone;
Chilkat .NET Core Event Implementation
Event callback implementation:
public void handlePercentDone(int pctDone, out bool abort)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); // ... Chilkat.ZipEntry.PercentDone percentDone = new Chilkat.ZipEntry.PercentDone(handlePercentDone); zipentry.setPercentDoneCb(percentDone);
ProgressInfo
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.
Chilkat .NET Framework Event Implementation
Args are passed using Chilkat.ProgressInfoEventArgs
Event callback implementation:
private void zipentry_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); zipentry.OnProgressInfo += zipentry_OnProgressInfo;
Chilkat .NET Core Event Implementation
Event callback implementation:
public void handleProgressInfo(string name, string value)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); // ... Chilkat.ZipEntry.ProgressInfo progressInfo = new Chilkat.ZipEntry.ProgressInfo(handleProgressInfo); zipentry.setProgressInfoCb(progressInfo);
TaskCompleted
Called from the background thread when an asynchronous task completes.
Chilkat .NET Framework Event Implementation
Args are passed using Chilkat.TaskCompletedEventArgs
Event callback implementation:
private void zipentry_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); zipentry.OnTaskCompleted += zipentry_OnTaskCompleted;
Chilkat .NET Core Event Implementation
Event callback implementation:
public void handleTaskIdCompleted(int taskId)
{
// application code goes here.
}
To add an event handler:
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry(); // ... Chilkat.ZipEntry.TaskIdCompleted taskIdCompleted = new Chilkat.ZipEntry.TaskIdCompleted(handleTaskIdCompleted); zipentry.setTaskIdCompletedCb(taskIdCompleted);
Deprecated
GetDt
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 null on failure
NextEntry
This method is deprecated. Applications should instead call GetNext.
Return the next entry (file or directory) within the Zip
Returns null on failure
NextMatchingEntry
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 null on failure