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

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

interface XMarkableStream

Base Interface
com::sun::star::uno::XInterface

Description
makes it possible to set and remove seekable marks to a stream.


Known Services which Export this Interface

com::sun::star::io::ObjectInputStream is a stream which allows reading the data of persistent objects.
com::sun::star::io::MarkableOutputStream allows to set marks in an outputstream and to later jump back to these marks.
com::sun::star::io::MarkableInputStream allows to set marks in an inputstream and to later jump back to these marks.
com::sun::star::io::ObjectInputStream is a stream which allows reading the data of persistent objects.
com::sun::star::io::MarkableOutputStream allows to set marks in an outputstream and to later jump back to these marks.
com::sun::star::io::MarkableInputStream allows to set marks in an inputstream and to later jump back to these marks.

Methods' Summary

createMark creates a mark of the current postion and returns an identifier to it.
deleteMark deletes the mark that you previously created with XMarkableStream::createMark .
jumpToMark jumps to a previously created mark.
jumpToFurthest jumps to the furthest position of the stream.
offsetToMark

Methods' Details

createMark
 
long
createMark( )
raises ( com::sun::star::io::IOException );

Description
creates a mark of the current postion and returns an identifier to it.
deleteMark
 
void
deleteMark(
[ in ] long Mark )
raises ( com::sun::star::io::IOException, com::sun::star::lang::IllegalArgumentException );

Description
deletes the mark that you previously created with XMarkableStream::createMark .

It is an error to delete a mark if other marks after this exist. In this case, for reasons of robustness, the implementation must delete this mark and all others after this mark.

jumpToMark
 
void
jumpToMark(
[ in ] long nMark )
raises ( com::sun::star::io::IOException, com::sun::star::lang::IllegalArgumentException );

Description
jumps to a previously created mark.
jumpToFurthest
 
void
jumpToFurthest( )
raises ( com::sun::star::io::IOException );

Description
jumps to the furthest position of the stream.

In the inputstream case, a subsequent read call returns data, that was never read or skipped over before. In the outputstream case, a subsequent write call will add new data at the end of the stream without overwriting existing data.

offsetToMark
 
long
offsetToMark(
[ in ] long nMark )
raises ( com::sun::star::io::IOException, com::sun::star::lang::IllegalArgumentException );

Returns
the offset from the current stream position to the mark ("current position" - "mark position").
Parameter nMark
identifies the mark which is used as a base to calculate the offset of the current position.
Throws
IllegalArgumentException if the mark does not exist or is deleted.
Throws
IOException if an I/O error has occurred.

Top of Page