ZipEntry Delphi ActiveX Reference Documentation

TChilkatZipEntry

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

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.


Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).


Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. See also: ActiveX Registration Tutorial
  3. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) should be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

Object Creation

var
obj: TChilkatZipEntry;
...
begin
obj := TChilkatZipEntry.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

Comment
property Comment: WideString

The comment stored within the Zip for this entry.

top
CompressedLength
property CompressedLength: Integer readonly

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

top
CompressedLengthStr
property CompressedLengthStr: WideString readonly

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

top
CompressionLevel
property CompressionLevel: Integer

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

top
CompressionMethod
property CompressionMethod: 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
property Crc: 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
property DebugLogFilePath: WideString

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
property EncryptionKeyLen: 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
property EntryID: Integer readonly

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

top
EntryType
property EntryType: 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
FileDateTimeStr
property FileDateTimeStr: WideString

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

top
FileName
property FileName: WideString

The file name of the Zip entry.

top
FileNameHex
property FileNameHex: WideString readonly

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

top
HeartbeatMs
property HeartbeatMs: 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
property IsAesEncrypted: Integer readonly
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
property IsDirectory: Integer readonly

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

top
LastBinaryResult
property LastBinaryResult: OleVariant readonly

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

top
LastErrorHtml
property LastErrorHtml: WideString 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
property LastErrorText: WideString 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
property LastErrorXml: WideString 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
property LastMethodSuccess: Integer

Indicates the success or failure of the most recent method call: 1 means success, 0 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
LastStringResult
property LastStringResult: WideString readonly

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

top
LastStringResultLen
property LastStringResultLen: Integer readonly

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

top
TextFlag
property TextFlag: Integer

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
property UncompressedLength: Integer readonly

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

top
UncompressedLengthStr
property UncompressedLengthStr: WideString readonly

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

top
VerboseLogging
property VerboseLogging: Integer

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
property Version: WideString readonly

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

More Information and Examples
top

Methods

AppendData
function AppendData(inData: OleVariant): Integer;

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

Returns 1 for success, 0 for failure.

top
AppendDataAsync (1)
function AppendDataAsync(inData: OleVariant): TChilkatTask;

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 nil on failure

top
AppendString
function AppendString(strContent: WideString; charset: WideString): Integer;

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)
function AppendStringAsync(strContent: WideString; charset: WideString): TChilkatTask;

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 nil on failure

top
Copy
function Copy(): OleVariant;

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 an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

top
CopyToBase64
function CopyToBase64(): WideString;

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 a zero-length WideString on failure

top
CopyToHex
function CopyToHex(): WideString;

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 a zero-length WideString on failure

top
Extract
function Extract(dirPath: WideString): Integer;

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)
function ExtractAsync(dirPath: WideString): TChilkatTask;

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 nil on failure

top
ExtractInto
function ExtractInto(dirPath: WideString): Integer;

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)
function ExtractIntoAsync(dirPath: WideString): TChilkatTask;

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 nil on failure

top
GetNext
function GetNext(): Integer;
Introduced in version 11.0.0

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

Returns 1 for success, 0 for failure.

top
GetNextMatch
function GetNextMatch(pattern: WideString): Integer;
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 1 for success, 0 for failure.

top
Inflate
function Inflate(): OleVariant;

Inflate a file within a Zip directly into memory.

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

More Information and Examples
top
InflateAsync (1)
function InflateAsync(): TChilkatTask;

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 nil on failure

top
LoadTaskCaller
function LoadTaskCaller(task: TChilkatTask): Integer;
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

top
ReplaceData
function ReplaceData(inData: OleVariant): Integer;

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

Returns 1 for success, 0 for failure.

top
ReplaceString
function ReplaceString(strContent: WideString; charset: WideString): Integer;

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
SetDt
procedure SetDt(dt: TCkDateTime);

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

top
UnzipToBd
function UnzipToBd(binData: TChilkatBinData): Integer;
Introduced in version 9.5.0.67

Unzips the entry contents into the binData.

Returns 1 for success, 0 for failure.

top
UnzipToBdAsync (1)
function UnzipToBdAsync(binData: TChilkatBinData): TChilkatTask;
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 nil on failure

top
UnzipToSb
function UnzipToSb(lineEndingBehavior: Integer; srcCharset: WideString; sb: TChilkatStringBuilder): Integer;
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)
function UnzipToSbAsync(lineEndingBehavior: Integer; srcCharset: WideString; sb: TChilkatStringBuilder): TChilkatTask;
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 nil on failure

top
UnzipToStream
function UnzipToStream(toStream: TChilkatStream): Integer;
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)
function UnzipToStreamAsync(toStream: TChilkatStream): TChilkatTask;
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 nil on failure

More Information and Examples
top
UnzipToString
function UnzipToString(lineEndingBehavior: Integer; srcCharset: WideString): WideString;

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 a zero-length WideString on failure

top
UnzipToStringAsync (1)
function UnzipToStringAsync(lineEndingBehavior: Integer; srcCharset: WideString): TChilkatTask;

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 nil on failure

top

Events

AbortCheck
procedure AbortCheck(ASender: TObject; out abort: Integer);

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

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryAbortCheck(ASender: TObject;  out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnAbortCheck := zipentryAbortCheck;
  // ...
top
PercentDone
procedure PercentDone(ASender: TObject; pctDone: Integer; out abort: Integer);

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 1. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryPercentDone(ASender: TObject;  pctDone: Integer; out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnPercentDone := zipentryPercentDone;
  // ...
top
ProgressInfo
procedure ProgressInfo(ASender: TObject; const name: WideString; const value: WideString);

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

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryProgressInfo(ASender: TObject;  const name: WideString; const value: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnProgressInfo := zipentryProgressInfo;
  // ...
top
TaskCompleted
procedure TaskCompleted(ASender: TObject; const task: IChilkatTask);

Called from the background thread when an asynchronous task completes.

More Information and Examples

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryTaskCompleted(ASender: TObject;  const task: IChilkatTask);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnTaskCompleted := zipentryTaskCompleted;
  // ...
top

Deprecated

GetDt
function GetDt(): TCkDateTime;
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 nil on failure

top
NextEntry
function NextEntry(): TChilkatZipEntry;
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 nil on failure

top
NextMatchingEntry
function NextMatchingEntry(matchStr: WideString): TChilkatZipEntry;
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 nil on failure

More Information and Examples
top