ChilkatGzip ActiveX Reference (Visual Basic)
ChilkatGzip
GZip compression component.
Properties
Comment As String
Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called.
ExtraData As Variant
Optional extra-data that can be included within a .gz when a Compress* method is called.
Filename As String
The filename that is embedded within the .gz during any Compress* method call. When extracting from a .gz using applications such as WinZip, this will be the filename that is created.
LastErrorHtml As String (read-only)
Error information in HTML format for the last method called.
LastErrorText As String (read-only)
Error information in plain-text format for the last method called.
LastErrorXml As String (read-only)
Error information in XML format for the last method called.
LastMod As Date
The last-modification date/time to be embedded within the .gz when a Compress* method is called. By default, the current system date/time is used.
Version As String (read-only)
To be documented soon...
Methods
CompressFile(inFilename As String, outFilename As String) As Long
Compresses a file to create a GZip compressed file (.gz). Returns 1 for success, 0 for failure.
CompressFileToMem(inFilename As String) As Variant
Gzip compresses a file to an in-memory image of a .gz file. Returns an empty Variant on failure. Returns a zero-length byte array (as a Variant) on failure
CompressMemToFile(inData As Variant, outFilename As String) As Long
Gzip compresses and creates a .gz file from in-memory data. Returns 1 for success, 0 for failure.
CompressMemory(inData As Variant) As Variant
Compresses in-memory data to an in-memory image of a .gz file. Returns a zero-length byte array (as a Variant) on failure
CompressString(inStr As String, outCharset As String) As Variant
To be documented soon...
CompressStringToFile(inStr As String, outCharset As String, outFilename As String) As Long
To be documented soon...
DeflateStringENC(inStr As String, charset As String, encoding As String) As String
To be documented soon...
InflateStringENC(inStr As String, charset As String, encoding As String) As String
To be documented soon...
IsUnlocked() As Long
Returns true if the component has been unlocked. (For ActiveX, returns 1 if unlocked.)
ReadFile(filename As String) As Variant
To be documented soon...
SaveLastError(filename As String)
Saves the last error information to an XML formatted file.
UnTarGz(gzFilename As String, destDir As String, noAbsolute As Long) As Long
Unpacks a .tar.gz file. The ungzip and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring. Returns 1 for success, 0 for failure.
UncompressFile(inFilename As String, outFilename As String) As Long
Un-Gzips a .gz file. The output filename is specified by the 2nd argument and not by the filename embedded within the .gz. Returns 1 for success, 0 for failure.
UncompressFileToMem(inFilename As String) As Variant
Un-Gzips a .gz file directly to memory. Returns an empty Variant on failure. Returns a zero-length byte array (as a Variant) on failure
UncompressFileToString(inFilename As String, inCharset As String) As String
To be documented soon...
UncompressMemToFile(inData As Variant, outFilename As String) As Long
Un-Gzips from an in-memory image of a .gz file to a file. Returns 1 for success, 0 for failure.
UncompressMemory(inData As Variant) As Variant
Un-Gzips from an in-memory image of a .gz file directly into memory. Returns an empty Variant on failure. Returns a zero-length byte array (as a Variant) on failure
UncompressString(inData As Variant, inCharset As String) As String
To be documented soon...
UnlockComponent(b1 As String) As Long
Unlocks the component allowing for the full functionality to be used. Returns 1 for success, 0 for failure.
WriteFile(filename As String, binaryData As Variant) As Long
To be documented soon...
|