CkRarEntry Ruby Programming
Reference Documentation

CkRarEntry

Properties

# Returns an integer value
get_CompressedSize( )

The compressed size in bytes of the file within the RAR archive. Directories have a compressed size of 0.

# Returns an integer value
get_Crc( )

The CRC checksum.

# str is a CkString object (output)
get_Filename( str )

The filename, which can include a relative directory path.

# Returns a boolean value
get_IsDirectory( )

true if the entry is a directory, false if it is a file.

# Returns a boolean value
get_IsReadOnly( )

true if the file permissions are set to read-only after extraction. Otherwise set to false for read-write.

# 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_LastModified( sysTime )

The last-modified date/time of the fille. When extracting, the file's last-mod date/time is set to this value.

# Returns an integer value
get_UncompressedSize( )

The size (in bytes) of the file when uncompressed.

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

To be documented soon...

Methods

# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

# dirPath is a string (input)
# Returns a boolean value
Unrar( dirPath )

Extracts the file to the dirPath specified.

# Returns a string
filename( )

The filename, which can include a relative directory path.

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