ZipEntry PureBasic Reference Documentation
ZipEntry
Current Version: 10.1.2
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
obj.i = CkZipEntry::ckCreate()
; Make sure to dispose of the object when finished like this:
CkZipEntry::ckDispose(obj);
Properties
Comment
Declare setCkComment(obj.i, value.s)
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
Declare setCkCompressionLevel(obj.i, value.i)
The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.
topCompressionMethod
Declare setCkCompressionMethod(obj.i, value.i)
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
Declare setCkDebugLogFilePath(obj.i, value.s)
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:
- 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.
FileDateTimeStr
Declare setCkFileDateTimeStr(obj.i, value.s)
The local last-modified date/time in RFC822 string format.
topFileName
Declare setCkFileName(obj.i, value.s)
FileNameHex
A string containing the hex encoded raw filename bytes found in the Zip entry.
topIsAesEncrypted
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.
topIsDirectory
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
Declare setCkLastMethodSuccess(obj.i, value.i)
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.
topTextFlag
Declare setCkTextFlag(obj.i, value.i)
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.
topUncompressedLength
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
Declare setCkVerboseLogging(obj.i, value.i)
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.
topVersion
Methods
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 1 for success, 0 for failure.
topAppendStringAsync (1)
Creates an asynchronous task to call the AppendString method with the arguments provided.
Returns 0 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 an empty string on failure. Use the LastMethodSuccess property to check for success.
topCopyToHex
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 an empty string on failure. Use the LastMethodSuccess property to check for success.
topExtract
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.
topExtractAsync (1)
Creates an asynchronous task to call the Extract method with the arguments provided.
Returns 0 on failure
topExtractInto
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.
topExtractIntoAsync (1)
Creates an asynchronous task to call the ExtractInto method with the arguments provided.
Returns 0 on failure
topGetDt
LoadTaskCaller
NextEntry
Return the next entry (file or directory) within the Zip
Returns 0 on failure
NextMatchingEntry
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 0 on failure
ReplaceString
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.
SetDt
Sets the last-modified date/time for this zip entry.
topUnzipToBd
UnzipToBdAsync (1)
Creates an asynchronous task to call the UnzipToBd method with the arguments provided.
Returns 0 on failure
topUnzipToSb
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.
topUnzipToSbAsync (1)
Creates an asynchronous task to call the UnzipToSb method with the arguments provided.
Returns 0 on failure
topUnzipToStream
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.
UnzipToStreamAsync (1)
Creates an asynchronous task to call the UnzipToStream method with the arguments provided.
Returns 0 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 an empty string on failure. Use the LastMethodSuccess property to check for success.
UnzipToStringAsync (1)
Creates an asynchronous task to call the UnzipToString method with the arguments provided.
Returns 0 on failure
top