fread_char — Read one character from a text file.
fread_char reads a character from the input
file defined by
The input file must have been opened with
open_file in text format.
The read character or the control character sequence 'eof' is returned in
fread_char respects the encoding of the characters,
unless the file was opened with the option 'ignore_encoding'
Thus, when opened with the correct encoding the operator
returns multi-byte characters at once.
If necessary, the character is transcoded into the current encoding of the
HALCON library (see
When the file was opened with encoding mode 'ignore_encoding',
Char always returns one byte without any interpretation or
transcoding. This is useful for reading a file with special control bytes
in a kind of raw mode.
If no character can be read because the end of the file is reached,
fread_char returns the control character sequence 'eof' in
fread_char emits a low-level error message, when
the next byte or byte sequence does not represent a valid code point in the
specified encoding. Despite of the low-level error message, the operator
will not fail and
Char will contain the next byte.
Furthermore, the operator also emits a low-level error
message, when the read character cannot be transcoded without loss of
information into the current encoding of the HALCON library.
This can only happen when the file is UTF-8 encoded and the
current encoding of the HALCON library is 'locale'
Read character, which can be multi-byte or the control string 'eof'.
* Read a text file character by character. open_file (FileName, 'input', FileHandle) repeat fread_char (FileHandle, Char) until (Char == 'eof') close_file (FileHandle)
If an input file is open, the operator
fread_char returns TRUE.
Otherwise, an exception is raised.
Encoding errors have no influence on the result state.