interface XTextInputStream in module com::sun::star::io::

(Global Index)

Syntax

interface XTextInputStream : com::sun::star::io::XInputStream ;

Description

makes it possible to read machine-independent simple data types from a stream.

Method Summary

readLine reads text until a line break (CR, LF, or CR/LF) or EOF is found and returns it as string (without CR, LF).

readString reads text until one of the given delimiter characters or EOF is found.

isEOF

setEncoding sets character encoding.

Known Services Which Export this Interface

com::sun::star::io::TextInputStream

com::sun::star::io::TextInputStream

Method Details



readLine

Syntax

string readLine ();
raises ( com::sun::star::io::IOException );

Description

reads text until a line break (CR, LF, or CR/LF) or EOF is found and returns it as string (without CR, LF).

The read characters are converted according to the encoding defined by XTextInputStream::setEncoding .


readString

Syntax

string readString (
sequence< char > Delimiters,
boolean bRemoveDelimiter )
raises ( com::sun::star::io::IOException );

Description

reads text until one of the given delimiter characters or EOF is found.

Important: CR/LF is not used as default delimiter! So if no delimiter is defined or none of the delimiters is found, the stream will be read to EOF. The read characters are converted according to the encoding defined by XTextInputStream::setEncoding .

See also

setEncoding

isEOF

Syntax

boolean isEOF ();
raises ( com::sun::star::io::IOException );

Returns

true , if the end of file is reached, so that no next string can be read.

See also

setEncoding

setEncoding

Syntax

void setEncoding (
string Encoding );

Description

sets character encoding.

Top of Page