CkGzip Ruby Programming
Reference Documentation
CkGzip
GZip compression component.
Object Creation
obj = Chilkat::CkGzip.new()
Properties
# str is a CkString object (output)
get_Comment( str )
# str is a string (input)
put_Comment( str )
Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called.
# data is a CkByteData object (output)
get_ExtraData( data )
# data is a CkByteData object (input)
put_ExtraData( data )
Optional extra-data that can be included within a .gz when a Compress* method is called.
# str is a CkString object (output)
get_Filename( str )
# str is a string (input)
put_Filename( str )
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.
# str is a CkString object (output)
LastErrorHtml( str )
Error information in HTML format for the last method called.
# str is a CkString object (output)
LastErrorText( str )
Error information in plain-text format for the last method called.
# str is a CkString object (output)
LastErrorXml( str )
Error information in XML format for the last method called.
# sysTime is a SYSTEMTIME object (output)
get_LastMod( sysTime )
# sysTime is a SYSTEMTIME object (output)
put_LastMod( sysTime )
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.
# Returns a boolean value
get_UseCurrentDate( )
# newVal is a boolean (input)
put_UseCurrentDate( newVal )
If set to true, the file produced by an Uncompress* method will use the current date/time for the last-modification date instead of the date/time found within the Gzip format.
# Returns a boolean value
get_Utf8( )
# b is a boolean (input)
put_Utf8( b )
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
# Returns a boolean value
get_VerboseLogging( )
# newVal is a boolean (input)
put_VerboseLogging( newVal )
To be documented soon...
# str is a CkString object (output)
get_Version( str )
Version of the component, such as "1.0.0"
Methods
# inFilename is a string (input)
# outGzipFilename is a string (input)
# Returns a boolean value
CompressFile( inFilename, outGzipFilename )
Compresses a file to create a GZip compressed file (.gz). Returns true for success, false for failure.
# inFilename is a string (input)
# embeddedFilename is a string (input)
# outGzipFilename is a string (input)
# Returns a boolean value
CompressFile2( inFilename, embeddedFilename, outGzipFilename )
Compresses a file to create a GZip compressed file (.gz). inFilename is the actual filename on disk. embeddedFilename is the filename to be embedded in the .gz such that when it is un-gzipped, this is the name of the file that will be created. Returns true for success, false for failure.
# inFilename is a string (input)
# db is a CkByteData object (output)
# Returns a boolean value
CompressFileToMem( inFilename, db )
Gzip compresses a file to an in-memory image of a .gz file.
# db is a CkByteData object (input)
# outFilename is a string (input)
# Returns a boolean value
CompressMemToFile( db, outFilename )
Gzip compresses and creates a .gz file from in-memory data. Returns true for success, false for failure.
# dbIn is a CkByteData object (input)
# dbOut is a CkByteData object (output)
# Returns a boolean value
CompressMemory( dbIn, dbOut )
Compresses in-memory data to an in-memory image of a .gz file.
# inString is a string (input)
# outCharset is a string (input)
# outBytes is a CkByteData object (output)
# Returns a boolean value
CompressString( inString, outCharset, outBytes )
Gzip compresses a string and writes the output to a byte array. The string is first converted to the charset specified by outCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc. Full List of Charset Names
# inStr is a string (input)
# outCharset is a string (input)
# outFilename is a string (input)
# Returns an integer value
CompressStringToFile( inStr, outCharset, outFilename )
Gzip compresses a string and writes the output to a .gz compressed file. The string is first converted to the charset specified by ARG2. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc. Returns true for success, false for failure. Full List of Charset Names
# encodedStr is a string (input)
# encoding is a string (input)
# outBytes is a CkByteData object (output)
# Returns a boolean value
Decode( encodedStr, encoding, outBytes )
Decodes an encoded string and returns the original data. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".
# inString is a string (input)
# charsetName is a string (input)
# outputEncoding is a string (input)
# strOut is a CkString object (output)
DeflateStringENC( inString, charsetName, outputEncoding, strOut )
Provides the ability to use the zip/gzip's deflate algorithm directly to compress a string. Internal to this method, inString is first converted to the charset specified by charsetName. The data is then compressed using the deflate compression algorithm. The binary output is then encoded according to outputEncoding. Possible values for outputEncoding are "hex", "base64", "url", and "quoted-printable".
Note: The output of this method is compressed data with no Gzip file format. Use the Compress* methods to produce Gzip file format output. Returns true for success, false for failure. Full List of Charset Names
# byteData is a CkByteData object (output)
# encoding is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
Encode( byteData, encoding, outStr )
Encodes binary data to a printable string. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url". Returns true for success, false for failure.
# inGzFilename is a string (input)
# Returns a boolean value
ExamineFile( inGzFilename )
Determines if the inGzFilename is a Gzip formatted file. Returns true if it is a Gzip formatted file, otherwise returns false.
# inGzData is a CkByteData object (output)
# Returns a boolean value
ExamineMemory( inGzData )
Determines if the in-memory bytes (inGzData) contain a Gzip formatted file. Returns true if it is Gzip format, otherwise returns false.
# inString is a string (input)
# convertFromCharset is a string (input)
# inputEncoding is a string (input)
# strOut is a CkString object (output)
InflateStringENC( inString, convertFromCharset, inputEncoding, strOut )
This the reverse of DeflateStringENC.
The input string is first decoded according to inputEncoding. (Possible values for inputEncoding are "hex", "base64", "url", and "quoted-printable".) The compressed data is then inflated, and the result is then converted from convertFromCharset (if necessary) to return a string. Returns true for success, false for failure.
# Returns a boolean value
IsUnlocked( )
Returns true if the component has been unlocked.
# filename is a string (input)
# outBytes is a CkByteData object (output)
# Returns a boolean value
ReadFile( filename, outBytes )
Reads a binary file into memory and returns the byte array. Note: This method does not parse a Gzip, it is only a convenience method for reading a binary file into memory.
# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )
Saves the last error information to an XML formatted file.
# tgzFilename is a string (input)
# destDir is a string (input)
# bNoAbsolute is a boolean (input)
# Returns a boolean value
UnTarGz( tgzFilename, destDir, bNoAbsolute )
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. bNoAbsolute may be true or false. A value of true protects from untarring to absolute paths. (For example, imagine the trouble if the tar contains files with absolute paths beginning with /Windows/system32) Returns true for success, false for failure.
# inFilename is a string (input)
# outFilename is a string (input)
# Returns a boolean value
UncompressFile( inFilename, outFilename )
Un-Gzips a .gz file. The output filename is specified by the 2nd argument and not by the filename embedded within the .gz. Returns true for success, false for failure.
# inFilename is a string (input)
# db is a CkByteData object (output)
# Returns a boolean value
UncompressFileToMem( inFilename, db )
Un-Gzips a .gz file directly to memory.
# gzFilename is a string (input)
# charset is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
UncompressFileToString( gzFilename, charset, outStr )
Uncompresses a .gz file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc. Returns true for success, false for failure. List of Valid Charsets
# db is a CkByteData object (input)
# outFilename is a string (input)
# Returns a boolean value
UncompressMemToFile( db, outFilename )
Un-Gzips from an in-memory image of a .gz file to a file. Returns true for success, false for failure.
# dbIn is a CkByteData object (input)
# dbOut is a CkByteData object (output)
# Returns a boolean value
UncompressMemory( dbIn, dbOut )
Un-Gzips from an in-memory image of a .gz file directly into memory.
# inData is a CkByteData object (output)
# inCharset is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
UncompressString( inData, inCharset, outStr )
The reverse of CompressString.
The bytes in inData are uncompressed, then converted from inCharset (if necessary) to return a string. Returns true for success, false for failure. Full List of Charset Names
# unlockCode is a string (input)
# Returns a boolean value
UnlockComponent( unlockCode )
Unlocks the component allowing for the full functionality to be used. Returns true for success, false for failure.
# filename is a string (input)
# binaryData is a CkByteData object (output)
# Returns a boolean value
WriteFile( filename, binaryData )
A convenience method for writing a binary byte array to a file. Returns true for success, false for failure.
# xfldData is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
XfdlToXml( xfldData, outStr )
Converts base64-gzip .xfdl data to a decompressed XML string. The xfldData contains the base64 data. This method returns the decoded/decompressed XML string. Returns true for success, false for failure.
# Returns a string
comment( )
Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called. Returns a null on failure
# inString is a string (input)
# charsetName is a string (input)
# outputEncoding is a string (input)
# Returns a string
deflateStringENC( inString, charsetName, outputEncoding )
Provides the ability to use the zip/gzip's deflate algorithm directly to compress a string. Internal to this method, inString is first converted to the charset specified by charsetName. The data is then compressed using the deflate compression algorithm. The binary output is then encoded according to outputEncoding. Possible values for outputEncoding are "hex", "base64", "url", and "quoted-printable".
Note: The output of this method is compressed data with no Gzip file format. Use the Compress* methods to produce Gzip file format output. Returns a null on failure Full List of Charset Names
# byteData is a CkByteData object (output)
# encoding is a string (input)
# Returns a string
encode( byteData, encoding )
Encodes binary data to a printable string. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url". Returns a null on failure
# Returns a string
filename( )
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. Returns a null on failure
# inString is a string (input)
# convertFromCharset is a string (input)
# inputEncoding is a string (input)
# Returns a string
inflateStringENC( inString, convertFromCharset, inputEncoding )
This the reverse of DeflateStringENC.
The input string is first decoded according to inputEncoding. (Possible values for inputEncoding are "hex", "base64", "url", and "quoted-printable".) The compressed data is then inflated, and the result is then converted from convertFromCharset (if necessary) to return a string. Returns a null on failure
# Returns a string
lastErrorHtml( )
Error information in HTML format for the last method called.Returns a null on failure
# Returns a string
lastErrorText( )
Error information in plain-text format for the last method called.Returns a null on failure
# Returns a string
lastErrorXml( )
Error information in XML format for the last method called.Returns a null on failure
# gzFilename is a string (input)
# charset is a string (input)
# Returns a string
uncompressFileToString( gzFilename, charset )
Uncompresses a .gz file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc. Returns a null on failure List of Valid Charsets
# inData is a CkByteData object (output)
# inCharset is a string (input)
# Returns a string
uncompressString( inData, inCharset )
The reverse of CompressString.
The bytes in inData are uncompressed, then converted from inCharset (if necessary) to return a string. Returns a null on failure Full List of Charset Names
# Returns a string
version( )
Version of the component, such as "1.0.0" Returns a null on failure
# xfldData is a string (input)
# Returns a string
xfdlToXml( xfldData )
Converts base64-gzip .xfdl data to a decompressed XML string. The xfldData contains the base64 data. This method returns the decoded/decompressed XML string. Returns a null on failure
|