Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XTextInputStream

Base Interface
com::sun::star::io::XInputStream

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


Known Services which Export this Interface

com::sun::star::io::TextInputStream reads the data through a chained stream.
com::sun::star::io::TextInputStream reads the data through a chained stream.

Methods' 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.

Methods' Details

readLine
 
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
 
string
readString(
[ in ] sequence< char > Delimiters,
[ in ] 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
 
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
 
void
setEncoding(
[ in ] string Encoding );

Description
sets character encoding.

Top of Page