Libraries |
|
LZMA | Source Code |
|
|
lzmaFile
const type: lzmaFile
-
File implementation type to decompress a LZMA file. LZMA is a file format used for compression.
Function Summary | |||||
file |
| ||||
void |
| ||||
char |
| ||||
string |
| ||||
boolean |
| ||||
boolean |
| ||||
integer |
| ||||
boolean |
| ||||
void |
| ||||
integer |
|
Function Detail |
openLzmaFile
const func file: openLzmaFile (inout file: compressed)
-
Open a LZMA file for reading (decompression). LZMA is a file format used for 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.
getc
const func char: getc (inout lzmaFile: inFile)
-
Read a character from a lzmaFile.
- Returns:
- the character read.
gets
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.
eof
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.
hasNext
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.
length
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.
seekable
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.
seek
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.
tell
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.
|
|