CkZipEntry Ruby Reference Documentation
CkZipEntry
Current Version: 10.1.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
obj = Chilkat::CkZipEntry.new()
Properties
Comment
# ckStr is a CkString
zipEntry.get_Comment(ckStr);
strVal = zipEntry.comment();
zipEntry.put_Comment(strVal);
The comment stored within the Zip for this entry.
topCompressedLength
intVal = zipEntry.get_CompressedLength();
The size in bytes of this entry's file data when compression is applied
topCompressedLength64
int64Val = zipEntry.get_CompressedLength64();
The size in bytes of this entry's file data when compression is applied
topCompressedLengthStr
# ckStr is a CkString
zipEntry.get_CompressedLengthStr(ckStr);
strVal = zipEntry.compressedLengthStr();
The size in decimal string format of this file when Zip compression is applied.
topCompressionLevel
intVal = zipEntry.get_CompressionLevel();
zipEntry.put_CompressionLevel(intVal);
The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.
topCompressionMethod
intVal = zipEntry.get_CompressionMethod();
zipEntry.put_CompressionMethod(intVal);
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
intVal = zipEntry.get_Crc();
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
# ckStr is a CkString
zipEntry.get_DebugLogFilePath(ckStr);
strVal = zipEntry.debugLogFilePath();
zipEntry.put_DebugLogFilePath(strVal);
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
EncryptionKeyLen
intVal = zipEntry.get_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
intVal = zipEntry.get_EntryID();
A unique ID assigned to the entry while the object is instantiated in memory.
topEntryType
intVal = zipEntry.get_EntryType();
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
# ckStr is a CkString
zipEntry.get_FileDateTimeStr(ckStr);
strVal = zipEntry.fileDateTimeStr();
zipEntry.put_FileDateTimeStr(strVal);
The local last-modified date/time in RFC822 string format.
topFileName
# ckStr is a CkString
zipEntry.get_FileName(ckStr);
strVal = zipEntry.fileName();
zipEntry.put_FileName(strVal);
FileNameHex
# ckStr is a CkString
zipEntry.get_FileNameHex(ckStr);
strVal = zipEntry.fileNameHex();
A string containing the hex encoded raw filename bytes found in the Zip entry.
topIsAesEncrypted
boolVal = zipEntry.get_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.
topIsDirectory
boolVal = zipEntry.get_IsDirectory();
True if the Zip entry is a directory, false if it is a file.
topLastErrorHtml
# ckStr is a CkString
zipEntry.get_LastErrorHtml(ckStr);
strVal = zipEntry.lastErrorHtml();
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.
topLastErrorText
# ckStr is a CkString
zipEntry.get_LastErrorText(ckStr);
strVal = zipEntry.lastErrorText();
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.
LastErrorXml
# ckStr is a CkString
zipEntry.get_LastErrorXml(ckStr);
strVal = zipEntry.lastErrorXml();
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.
topLastMethodSuccess
boolVal = zipEntry.get_LastMethodSuccess();
zipEntry.put_LastMethodSuccess(boolVal);
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.
topTextFlag
boolVal = zipEntry.get_TextFlag();
zipEntry.put_TextFlag(boolVal);
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
intVal = zipEntry.get_UncompressedLength();
The size in bytes of this entry's file data when uncompressed.
topUncompressedLength64
int64Val = zipEntry.get_UncompressedLength64();
The size in bytes of this entry's file data when uncompressed.
topUncompressedLengthStr
# ckStr is a CkString
zipEntry.get_UncompressedLengthStr(ckStr);
strVal = zipEntry.uncompressedLengthStr();
The size in bytes (in decimal string format) of this zip entry's data when uncompressed.
topUtf8
boolVal = zipEntry.get_Utf8();
zipEntry.put_Utf8(boolVal);
When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = zipEntry.get_VerboseLogging();
zipEntry.put_VerboseLogging(boolVal);
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.
topVersion
# ckStr is a CkString
zipEntry.get_Version(ckStr);
strVal = zipEntry.version();
Methods
AppendData
Appends binary data to the zip entry's file contents.
Returns true for success, false for failure.
topAppendDataAsync (1)
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
topAppendString
# charset is a string
status = zipEntry.AppendString(strContent, charset);
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 (1)
# strContent is a string
# charset is a string
ret_task = zipEntry.AppendStringAsync(strContent, charset);
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
topCopy
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.
topCopyToBase64
status = zipEntry.CopyToBase64(outStr);
retStr = zipEntry.copyToBase64();
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.
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 true for success, false for failure.
topExtract
status = zipEntry.Extract(dirPath);
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 (1)
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
topExtractInto
status = zipEntry.ExtractInto(dirPath);
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 (1)
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
topGetDt
Inflate
InflateAsync (1)
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
topLoadTaskCaller
NextEntry
ret_zipEntry = zipEntry.NextEntry();
Return the next entry (file or directory) within the Zip
Returns nil on failure
NextMatchingEntry
status = zipEntry.NextMatchingEntry(matchStr);
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
ReplaceData
Replaces the zip entry's existing contents with new data.
Returns true for success, false for failure.
topReplaceString
# charset is a string
status = zipEntry.ReplaceString(strContent, charset);
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 (1)
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
topUnzipToSb
# srcCharset is a string
# sb is a CkStringBuilder
status = zipEntry.UnzipToSb(lineEndingBehavior, srcCharset, sb);
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 (1)
# lineEndingBehavior is an integer
# srcCharset is a string
# sb is a CkStringBuilder
ret_task = zipEntry.UnzipToSbAsync(lineEndingBehavior, srcCharset, sb);
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
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 true for success, false for failure.
UnzipToStreamAsync (1)
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
UnzipToString
# srcCharset is a string
# outStr is a CkString (output)
status = zipEntry.UnzipToString(lineEndingBehavior, srcCharset, outStr);
retStr = zipEntry.unzipToString(lineEndingBehavior, srcCharset);
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.
UnzipToStringAsync (1)
# lineEndingBehavior is an integer
# srcCharset is a string
ret_task = zipEntry.UnzipToStringAsync(lineEndingBehavior, srcCharset);
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