CkUnixCompress Java Programming Reference Documentation
CkUnixCompress
UNIX (.Z) compression component.
Object Creation
CkUnixCompress obj = new CkUnixCompress();
Properties
// 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.
Methods
// inFilename is a string (input) // outFilename is a string (input) // Returns a boolean value CompressFile( inFilename, outFilename )
Compresses a file to create a UNIX compressed file (.Z). This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm. 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 )
Unix compresses a file to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)
// db is a CkByteData object (input) // outFilename is a string (input) // Returns a boolean value CompressMemToFile( db, outFilename )
Unix compresses and creates a .Z file from in-memory data. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.) 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 .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)
// inStr is a string (input) // outCharset is a string (input) // outBytes is a CkByteData object (output) // Returns a boolean value CompressString( inStr, outCharset, outBytes )
To be documented soon...
// inStr is a string (input) // outCharset is a string (input) // outFilename is a string (input) // Returns a boolean value CompressStringToFile( inStr, outCharset, outFilename )
To be documented soon...
// Returns a boolean value IsUnlocked( )
Returns true if the component has been unlocked. (For ActiveX, returns 1 if unlocked.)
// filename is a string (input) // Returns a boolean value SaveLastError( filename )
Saves the last error information to an XML formatted file.
// zFilename is a string (input) // destDir is a string (input) // bNoAbsolute is a boolean (input) // Returns a boolean value UnTarZ( zFilename, destDir, bNoAbsolute )
Unpacks a .tar.Z file. The decompress and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring. Returns true for success, false for failure.
// inFilename is a string (input) // outFilename is a string (input) // Returns a boolean value UncompressFile( inFilename, outFilename )
Uncompresses a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.) 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 )
Uncompresses a .Z file directly to memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)
// zFilename is a string (input) // charset is a string (input) // outStr is a CkString object (output) // Returns a boolean value UncompressFileToString( zFilename, charset, outStr )
Uncompresses a .Z 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 )
Uncompresses from an in-memory image of a .Z file to a file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.) 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 )
Uncompresses from an in-memory image of a .Z file directly into memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)
// 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 )
To be documented soon...
// 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.
// 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
// zFilename is a string (input) // charset is a string (input) // Returns a string uncompressFileToString( zFilename, charset )
Uncompresses a .Z 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 )
To be documented soon...
|