get_char


Description:

public unichar get_char ()

The Unicode character at this iterator is returned.

(Equivalent to operator* on a C++ iterator.) If the element at this iterator is a non-character element, such as an image embedded in the buffer, the Unicode “unknown” character 0xFFFC is returned. If invoked on the end iterator, zero is returned; zero is not a valid Unicode character. So you can write a loop which ends when get_char returns 0.

Parameters:

this

an iterator

Returns:

a Unicode character, or 0 if this is not dereferenceable