CkUnixCompress Python Programming
Reference Documentation

CkUnixCompress

UNIX (.Z) compression component.

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.

# 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.

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.)

# 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.

# 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.)

# 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.)

# 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 string
lastErrorText( )

Error information in plain-text format for the last method called.

# Returns a string
lastErrorXml( )

Error information in XML format for the last method called.