const type: lzmaFile

File implementation type to decompress a LZMA file. LZMA is the Lempel–Ziv–Markov chain algorithm. LZMA performs lossless data compression.

const func string: lzmaDecompress (inout file: compressed, in integer: uncompressedSize)

Decompress a file that was compressed with LZMA. LZMA is the Lempel–Ziv–Markov chain algorithm. LZMA performs lossless data compression. This LZMA decompression function is tailored towards the header format used in ZIP files.

Returns:

the uncompressed string.

Raises:

RANGE_ERROR - If compressed is not in LZMA format.

const func file: openLzmaFile (inout file: compressed)

Open a LZMA file for reading (decompression). LZMA is the Lempel–Ziv–Markov chain algorithm. LZMA performs lossless data compression. Reading from the file delivers decompressed data. Writing is not supported.

Returns:

the file opened, or STD_NULL if the file is not in LZMA format.

const proc: close (in lzmaFile: aFile)

Close a lzmaFile.

const func char: getc (inout lzmaFile: inFile)

Read a character from a lzmaFile.

Returns:

the character read.

const func string: gets (inout lzmaFile: inFile, in integer: maxLength)

Read a string with maximum length from a lzmaFile.

Returns:

the string read.

Raises:

RANGE_ERROR - The parameter maxLength is negative.

const func boolean: eof (in lzmaFile: inFile)

Determine the end-of-file indicator. The end-of-file indicator is set if at least one request to read from the file failed.

Returns:

TRUE if the end-of-file indicator is set, FALSE otherwise.

const func boolean: hasNext (inout lzmaFile: inFile)

Determine if at least one character can be read successfully. This function allows a file to be handled like an iterator.

Returns:

FALSE if getc would return EOF, TRUE otherwise.

const func integer: length (inout lzmaFile: aFile)

Obtain the length of a file. The file length is measured in bytes.

Returns:

the length of a file, or 0 if it cannot be obtained.

const boolean: seekable (in lzmaFile: aFile)

Determine if the file aFile is seekable. If a file is seekable the functions seek and tell can be used to set and and obtain the current file position.

Returns:

TRUE, since a lzmaFile is seekable.

const proc: seek (inout lzmaFile: aFile, in integer: position)

Set the current file position. The file position is measured in bytes from the start of the file. The first byte in the file has the position 1.

Raises:

RANGE_ERROR - The file position is negative or zero.

const func integer: tell (in lzmaFile: aFile)

Obtain the current file position. The file position is measured in bytes from the start of the file. The first byte in the file has the position 1.

Returns:

the current file position.