Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » io

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: 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

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

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.