ZipEntry Delphi DLL Reference Documentation

ZipEntry

Current Version: 9.5.0.75

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

Create/Dispose

var
myObject: HCkZipEntry;

begin
myObject := CkZipEntry_Create();

// ...

CkZipEntry_Dispose(myObject);
end;
function CkZipEntry_Create: HCkZipEntry; stdcall;

Creates an instance of the HCkZipEntry object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkZipEntry_Dispose(handle: HCkZipEntry); stdcall;

Objects created by calling CkZipEntry_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

Comment
procedure CkZipEntry_getComment(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
procedure CkZipEntry_putComment(objHandle: HCkZipEntry; newPropVal: PWideChar); stdcall;
function CkZipEntry__comment(objHandle: HCkZipEntry): PWideChar; stdcall;

The comment stored within the Zip for this entry.

top
CompressedLength
function CkZipEntry_getCompressedLength(objHandle: HCkZipEntry): LongWord; stdcall;

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

top
CompressedLength64
function CkZipEntry_getCompressedLength64(objHandle: HCkZipEntry): Int64; stdcall;

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

top
CompressedLengthStr
procedure CkZipEntry_getCompressedLengthStr(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
function CkZipEntry__compressedLengthStr(objHandle: HCkZipEntry): PWideChar; stdcall;

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

top
CompressionLevel
function CkZipEntry_getCompressionLevel(objHandle: HCkZipEntry): Integer; stdcall;
procedure CkZipEntry_putCompressionLevel(objHandle: HCkZipEntry; newPropVal: Integer); stdcall;

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

top
CompressionMethod
function CkZipEntry_getCompressionMethod(objHandle: HCkZipEntry): Integer; stdcall;
procedure CkZipEntry_putCompressionMethod(objHandle: HCkZipEntry; newPropVal: Integer); stdcall;

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
function CkZipEntry_getCrc(objHandle: HCkZipEntry): Integer; stdcall;

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
procedure CkZipEntry_getDebugLogFilePath(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
procedure CkZipEntry_putDebugLogFilePath(objHandle: HCkZipEntry; newPropVal: PWideChar); stdcall;
function CkZipEntry__debugLogFilePath(objHandle: HCkZipEntry): PWideChar; stdcall;

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
function CkZipEntry_getEncryptionKeyLen(objHandle: HCkZipEntry): Integer; stdcall;
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
function CkZipEntry_getEntryID(objHandle: HCkZipEntry): Integer; stdcall;

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

top
EntryType
function CkZipEntry_getEntryType(objHandle: HCkZipEntry): Integer; stdcall;

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
FileDateTimeStr
procedure CkZipEntry_getFileDateTimeStr(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
procedure CkZipEntry_putFileDateTimeStr(objHandle: HCkZipEntry; newPropVal: PWideChar); stdcall;
function CkZipEntry__fileDateTimeStr(objHandle: HCkZipEntry): PWideChar; stdcall;

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

top
FileName
procedure CkZipEntry_getFileName(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
procedure CkZipEntry_putFileName(objHandle: HCkZipEntry; newPropVal: PWideChar); stdcall;
function CkZipEntry__fileName(objHandle: HCkZipEntry): PWideChar; stdcall;

The file name of the Zip entry.

top
FileNameHex
procedure CkZipEntry_getFileNameHex(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
function CkZipEntry__fileNameHex(objHandle: HCkZipEntry): PWideChar; stdcall;

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

top
IsAesEncrypted
function CkZipEntry_getIsAesEncrypted(objHandle: HCkZipEntry): wordbool; stdcall;
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
function CkZipEntry_getIsDirectory(objHandle: HCkZipEntry): wordbool; stdcall;

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

top
LastErrorHtml
procedure CkZipEntry_getLastErrorHtml(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
function CkZipEntry__lastErrorHtml(objHandle: HCkZipEntry): PWideChar; stdcall;

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
procedure CkZipEntry_getLastErrorText(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
function CkZipEntry__lastErrorText(objHandle: HCkZipEntry): PWideChar; stdcall;

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
procedure CkZipEntry_getLastErrorXml(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
function CkZipEntry__lastErrorXml(objHandle: HCkZipEntry): PWideChar; stdcall;

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
function CkZipEntry_getLastMethodSuccess(objHandle: HCkZipEntry): wordbool; stdcall;
procedure CkZipEntry_putLastMethodSuccess(objHandle: HCkZipEntry; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
TextFlag
function CkZipEntry_getTextFlag(objHandle: HCkZipEntry): wordbool; stdcall;
procedure CkZipEntry_putTextFlag(objHandle: HCkZipEntry; newPropVal: wordbool); stdcall;

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
function CkZipEntry_getUncompressedLength(objHandle: HCkZipEntry): LongWord; stdcall;

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

top
UncompressedLength64
function CkZipEntry_getUncompressedLength64(objHandle: HCkZipEntry): Int64; stdcall;

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

top
UncompressedLengthStr
procedure CkZipEntry_getUncompressedLengthStr(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
function CkZipEntry__uncompressedLengthStr(objHandle: HCkZipEntry): PWideChar; stdcall;

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

top
VerboseLogging
function CkZipEntry_getVerboseLogging(objHandle: HCkZipEntry): wordbool; stdcall;
procedure CkZipEntry_putVerboseLogging(objHandle: HCkZipEntry; newPropVal: wordbool); stdcall;

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
procedure CkZipEntry_getVersion(objHandle: HCkZipEntry; outPropVal: HCkString); stdcall;
function CkZipEntry__version(objHandle: HCkZipEntry): PWideChar; stdcall;

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

top

Methods

AppendData
function CkZipEntry_AppendData(objHandle: HCkZipEntry;
    inData: HCkByteData): wordbool; stdcall;

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

Returns True for success, False for failure.

top
AppendDataAsync (1)
function CkZipEntry_AppendDataAsync(objHandle: HCkZipEntry;
    inData: HCkByteData): HCkTask; stdcall;

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

Returns nil on failure

top
AppendString
function CkZipEntry_AppendString(objHandle: HCkZipEntry;
    strContent: PWideChar;
    charset: PWideChar): wordbool; stdcall;

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 CkZipEntry_AppendStringAsync(objHandle: HCkZipEntry;
    strContent: PWideChar;
    charset: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
Copy
function CkZipEntry_Copy(objHandle: HCkZipEntry;
    outData: HCkByteData): wordbool; stdcall;

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 True for success, False for failure.

top
CopyToBase64
function CkZipEntry_CopyToBase64(objHandle: HCkZipEntry;
    outStr: HCkString): wordbool; stdcall;
function CkZipEntry__copyToBase64(objHandle: HCkZipEntry): PWideChar; stdcall;

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 True for success, False for failure.

top
CopyToHex
function CkZipEntry_CopyToHex(objHandle: HCkZipEntry;
    outStr: HCkString): wordbool; stdcall;
function CkZipEntry__copyToHex(objHandle: HCkZipEntry): PWideChar; stdcall;

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 True for success, False for failure.

top
Extract
function CkZipEntry_Extract(objHandle: HCkZipEntry;
    dirPath: PWideChar): wordbool; stdcall;

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 CkZipEntry_ExtractAsync(objHandle: HCkZipEntry;
    dirPath: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
ExtractInto
function CkZipEntry_ExtractInto(objHandle: HCkZipEntry;
    dirPath: PWideChar): wordbool; stdcall;

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 CkZipEntry_ExtractIntoAsync(objHandle: HCkZipEntry;
    dirPath: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
GetDt
function CkZipEntry_GetDt(objHandle: HCkZipEntry): HCkDateTime; stdcall;

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

Returns nil on failure

top
Inflate
function CkZipEntry_Inflate(objHandle: HCkZipEntry;
    outData: HCkByteData): wordbool; stdcall;

Inflate a file within a Zip directly into memory.

Returns True for success, False for failure.

top
InflateAsync (1)
function CkZipEntry_InflateAsync(objHandle: HCkZipEntry): HCkTask; stdcall;

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

Returns nil on failure

top
NextEntry
function CkZipEntry_NextEntry(objHandle: HCkZipEntry): HCkZipEntry; stdcall;

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

Returns nil on failure

top
NextMatchingEntry
function CkZipEntry_NextMatchingEntry(objHandle: HCkZipEntry;
    matchStr: PWideChar): HCkZipEntry; stdcall;
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 nil on failure

More Information and Examples
top
ReplaceData
function CkZipEntry_ReplaceData(objHandle: HCkZipEntry;
    inData: HCkByteData): wordbool; stdcall;

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

Returns True for success, False for failure.

top
ReplaceString
function CkZipEntry_ReplaceString(objHandle: HCkZipEntry;
    strContent: PWideChar;
    charset: PWideChar): wordbool; stdcall;

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
SaveLastError
function CkZipEntry_SaveLastError(objHandle: HCkZipEntry;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
SetDt
procedure CkZipEntry_SetDt(objHandle: HCkZipEntry;
    dt: HCkDateTime) stdcall;

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

top
UnzipToBd
function CkZipEntry_UnzipToBd(objHandle: HCkZipEntry;
    binData: HCkBinData): wordbool; stdcall;
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 CkZipEntry_UnzipToBdAsync(objHandle: HCkZipEntry;
    binData: HCkBinData): HCkTask; stdcall;
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.)

Returns nil on failure

top
UnzipToSb
function CkZipEntry_UnzipToSb(objHandle: HCkZipEntry;
    lineEndingBehavior: Integer;
    srcCharset: PWideChar;
    sb: HCkStringBuilder): wordbool; stdcall;
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 CkZipEntry_UnzipToSbAsync(objHandle: HCkZipEntry;
    lineEndingBehavior: Integer;
    srcCharset: PWideChar;
    sb: HCkStringBuilder): HCkTask; stdcall;
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.)

Returns nil on failure

top
UnzipToStream
function CkZipEntry_UnzipToStream(objHandle: HCkZipEntry;
    toStream: HCkStream): wordbool; stdcall;
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 CkZipEntry_UnzipToStreamAsync(objHandle: HCkZipEntry;
    toStream: HCkStream): HCkTask; stdcall;
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.)

Returns nil on failure

More Information and Examples
top
UnzipToString
function CkZipEntry_UnzipToString(objHandle: HCkZipEntry;
    lineEndingBehavior: Integer;
    srcCharset: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkZipEntry__unzipToString(objHandle: HCkZipEntry;
    lineEndingBehavior: Integer;
    srcCharset: PWideChar): PWideChar; stdcall;

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 True for success, False for failure.

top
UnzipToStringAsync (1)
function CkZipEntry_UnzipToStringAsync(objHandle: HCkZipEntry;
    lineEndingBehavior: Integer;
    srcCharset: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top