ZipEntry SQL Server Reference Documentation
ZipEntry
Current Version: 11.6.0
Chilkat.ZipEntry
Inspect filenames, stored ZIP paths, comments, timestamps, CRC values,
attributes, sizes, compression method, and compression level.
Use
Extract a selected file entry to disk, inflate its contents into memory,
or read the uncompressed data into Chilkat objects.
Access the raw compressed entry data when an application needs ZIP-level
control rather than only the inflated contents.
Update an entry's contents from strings, byte data, files, or in-memory
data sources before writing the ZIP archive.
Walk through entries returned from
For an extended overview, see
ZipEntry Overview.
Inspect, extract, update, and iterate individual entries inside a ZIP archive.
Chilkat.ZipEntry represents a single item associated with a
Chilkat.Zip archive. An entry may be a file already stored in an
opened ZIP, a referenced filesystem file waiting to be compressed, an
in-memory text or binary entry, or a directory entry. It provides access to
entry-level metadata, compressed and uncompressed data, timestamps,
attributes, CRC values, encryption information, and extraction or replacement
operations for that specific ZIP item.
Entry metadata
Entry type and state
EntryType to understand whether the entry comes from an
existing ZIP, a filesystem reference, memory data, or a directory.
Extract one entry
Read compressed data
Replace or append data
Iterate archive entries
Chilkat.Zip methods to
inspect, filter, extract, or modify ZIP contents one item at a time.
Chilkat.Zip object, obtain a
ZipEntry using methods such as EntryAt,
EntryOf, EntryMatching, or
FirstEntry, then inspect metadata, extract contents, update the
entry, or continue iterating through the archive. Use
Chilkat.Zip for whole-archive operations and
ZipEntry for operations on one specific archive item.
Object Creation
DECLARE @hr int
DECLARE @zipEntry int
EXEC @hr = sp_OACreate 'Chilkat.ZipEntry', @zipEntry OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @zipEntry ...
EXEC @hr = sp_OADestroy @zipEntryT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.ZipEntry.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @zipEntry, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
Comment
EXEC sp_OASetProperty @zipEntry, 'Comment', @sValue
Gets or sets the comment stored in the ZIP archive for this entry.
topCompressedLength
The compressed size of this entry, in bytes.
For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.
For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:
- The current uncompressed data size for data entries.
- The cached filesystem file size for referenced file entries.
After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.
topCompressedLengthStr
The compressed size of this entry as a decimal string.
For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.
For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:
- The current uncompressed data size for data entries.
- The cached filesystem file size for referenced file entries.
After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.
This property is useful when sizes may exceed the range of a 32-bit integer.
topCompressionLevel
EXEC sp_OASetProperty @zipEntry, 'CompressionLevel', @iValue
Gets or sets the compression level for this entry.
A value of 0 means no compression, and a value of
9 means maximum compression.
The default value is 6.
CompressionMethod
EXEC sp_OASetProperty @zipEntry, 'CompressionMethod', @iValue
Gets or sets the compression method used for this entry.
-
0means no compression. -
8means Deflate compression.
Deflate is the standard compression algorithm used by common ZIP utilities such as WinZip.
topCrc
DebugLogFilePath
EXEC sp_OASetProperty @zipEntry, 'DebugLogFilePath', @sValue
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
The AES encryption key length for this entry.
If this entry is AES encrypted, the value is 128,
192, or 256.
If this entry is not AES encrypted, the value is 0.
EntryID
A unique identifier assigned to this entry while the ZIP object is instantiated in memory.
This ID can be used to retrieve the same entry later with
Zip.EntryById.
EntryType
Indicates the origin and current state of this ZIP entry.
-
0— Mapped Entry: an entry that already exists in an open ZIP file. -
1— File Entry: a file in the local filesystem that has been referenced, but not yet read or compressed. -
2— Data Entry: an entry containing uncompressed data already held in memory. -
3— Null Entry: an entry that no longer exists in the ZIP archive. -
4— New Directory Entry: a directory entry added to the ZIP object.
When the ZIP archive is written by calling WriteZip or
WriteToMemory, entries are transformed into mapped entries.
In other words, after writing, they point to compressed data contained
in the newly created or rewritten ZIP archive.
FileDateTimeStr
EXEC sp_OASetProperty @zipEntry, 'FileDateTimeStr', @sValue
Gets or sets the local last-modified date/time for this ZIP entry in RFC 822 string format.
Example RFC 822 date/time strings:
Tue, 15 Nov 1994 12:45:26 GMT
Fri, 05 Jan 2024 18:30:00 -0500
The timezone may be specified either as a named timezone such as
GMT, or as a numeric UTC offset such as
-0500.
FileName
EXEC sp_OASetProperty @zipEntry, 'FileName', @sValue
Gets or sets the filename, including any relative path, stored for this entry inside the ZIP archive.
Changing this property changes the path/name that will appear in the ZIP archive. It does not rename a source file in the local filesystem.
FileNameHex
Returns the raw filename bytes found in the ZIP entry, encoded as a hexadecimal string.
This can be useful for diagnosing filename encoding issues.
topIsAesEncrypted
Indicates whether this ZIP entry is AES encrypted.
This property can be 1OpenZip, OpenBd, or
OpenFromMemory.
If the entry is not AES encrypted, the property is
0
IsDirectory
Indicates whether this ZIP entry is a directory entry.
The value is 10
LastBinaryResult
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.
LastErrorHtml
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
EXEC sp_OASetProperty @zipEntry, 'LastMethodSuccess', @iValue
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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
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.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topTextFlag
EXEC sp_OASetProperty @zipEntry, 'TextFlag', @iValue
Gets or sets the text flag in the internal file attributes for this ZIP entry.
This flag indicates whether the entry contents should be considered text rather than binary data.
The flag is informational and does not need to be accurate for normal ZIP processing. It is provided for compatibility with applications that may be sensitive to this attribute.
topUncompressedLength
The uncompressed size of this entry, in bytes.
topUncompressedLengthStr
The uncompressed size of this ZIP entry as a decimal string.
This is useful when the uncompressed size may be larger than what can safely be represented by a 32-bit integer.
topVerboseLogging
EXEC sp_OASetProperty @zipEntry, 'VerboseLogging', @iValue
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.
Version
Methods
AppendString
Appends text data to this ZIP entry's file contents.
The text is converted to bytes using the character encoding specified
by charset, such as utf-8,
utf-16, or ansi.
If this entry is already a Data Entry
(EntryType = 2), then the encoded bytes are appended
directly to the existing uncompressed in-memory data.
If this entry is not already a Data Entry, then the entry is first converted into a Data Entry before the new text data is appended.
-
If the entry is a mapped entry
(
EntryType = 0), the compressed ZIP entry data is first inflated into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined uncompressed data. -
If the entry is a file entry
(
EntryType = 1), the referenced filesystem file is first loaded into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined data.
After this method is called, the entry contents exist entirely as uncompressed in-memory data associated with the ZipEntry object.
Returns 1 for success, 0 for failure.
CopyToBase64
Returns the compressed data for this ZIP entry as a Base64-encoded string.
This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.
This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.
Returns NULL on failure
CopyToHex
Returns the compressed data for this ZIP entry as a hexadecimal encoded string.
This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.
This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.
Returns NULL on failure
Extract
Extracts this ZIP entry beneath the specified base directory.
The entry is extracted according to the relative path stored in the ZIP archive.
For example, if the entry filename is
docs/readme.txt and dirPath is
c:/temp/output, the file is extracted to
c:/temp/output/docs/readme.txt.
Use ExtractInto instead if the file should be extracted
directly into a specific directory regardless of the path stored in
the ZIP archive.
Returns 1 for success, 0 for failure.
ExtractInto
Extracts this entry directly into the specified directory, ignoring any path information stored in the ZIP entry.
For example, if the entry filename is
docs/readme.txt and dirPath is
c:/temp/output, the file is extracted to
c:/temp/output/readme.txt.
If this entry is a directory entry, nothing is extracted. To create
the directory represented by a directory entry, use
Extract instead.
Returns 1 for success, 0 for failure.
topGetNext
Updates this ZipEntry object so that it represents the
next entry in the same ZIP archive.
The next entry may be either a file entry or a directory entry.
Returns 10
GetNextMatch
Updates this ZipEntry object so that it represents the
next entry in the ZIP archive matching the specified wildcard pattern.
The wildcard character * matches zero or more characters.
Matching is performed against the full stored filename, including any
relative path.
The matching entry may be either a file entry or a directory entry.
Returns 10
ReplaceString
Replaces this ZIP entry's existing contents with new text data.
The text is converted to bytes using the character encoding specified
by charset, such as utf-8 or
ansi.
The resulting bytes become the complete contents of the entry.
Returns 1 for success, 0 for failure.
SetDt
Sets the last-modified date/time for this ZIP entry.
The dt argument is a CkDateTime object
containing the date/time to store for the entry.
UnzipToBd
Unzips this entry directly into a BinData object.
The uncompressed bytes are written to binData.
Returns 1 for success, 0 for failure.
UnzipToSb
Unzips this entry as text and appends the result to a
StringBuilder.
The srcCharset argument specifies how the uncompressed
bytes should be interpreted, such as utf-8,
utf-16, or windows-1252.
The lineEndingBehavior argument controls line-ending
conversion:
-
0— leave line endings unchanged. -
1— convert all line endings to bare LF. -
2— convert all line endings to CRLF.
Returns 1 for success, 0 for failure.
UnzipToStream
Unzips this entry to a stream.
If called synchronously, the toStream must have a sink,
such as a file or another stream object.
If called asynchronously, the foreground thread can read from the stream while the unzip operation writes to it.
Returns 1 for success, 0 for failure.
topUnzipToString
Inflates this entry and returns the uncompressed data as a string.
The srcCharset argument specifies how the uncompressed
bytes should be interpreted, such as utf-8,
utf-16, or windows-1252.
The lineEndingBehavior argument controls line-ending
conversion:
-
0— leave line endings unchanged. -
1— convert all line endings to bare LF. -
2— convert all line endings to CRLF.
Returns NULL on failure
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