Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.13

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

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

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( IOException );

Description
creates a mark of the current postion and returns an identifier to it.
deleteMark
void
deleteMark( [in] long  Mark )
raises( 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( IOException,
::com::sun::star::lang::IllegalArgumentException );

Description
jumps to a previously created mark.
jumpToFurthest
void
jumpToFurthest()
raises( 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( 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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.