<html>
<head>
<title>Interface XMarkableStream</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">
<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XMarkableStream-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">io</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XMarkableStream</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>makes it possible to set and remove seekable marks to a stream.
</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createMark">createMark</a></td>
<td class="imsum_right">creates a mark of the current postion and returns an identifier to it.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#deleteMark">deleteMark</a></td>
<td class="imsum_right">deletes the mark that you previously created with
<a href="XMarkableStream.html">XMarkableStream</a>::<a href="XMarkableStream.html#createMark">createMark</a>.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#jumpToMark">jumpToMark</a></td>
<td class="imsum_right">jumps to a previously created mark.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#jumpToFurthest">jumpToFurthest</a></td>
<td class="imsum_right">jumps to the furthest position of the stream.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#offsetToMark">offsetToMark</a></td>
<td class="imsum_right"> </td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="createMark" class="membertitle">createMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>createMark</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="IOException.html">IOException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>creates a mark of the current postion and returns an identifier to it.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="deleteMark" class="membertitle">deleteMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>deleteMark</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> Mark )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="IOException.html">IOException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>deletes the mark that you previously created with
<a href="XMarkableStream.html">XMarkableStream</a>::<a href="XMarkableStream.html#createMark">createMark</a>.
</dd>
<dd><p>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. </p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="jumpToMark" class="membertitle">jumpToMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>jumpToMark</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> nMark )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="IOException.html">IOException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>jumps to a previously created mark.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="jumpToFurthest" class="membertitle">jumpToFurthest</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>jumpToFurthest</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="IOException.html">IOException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>jumps to the furthest position of the stream.
</dd>
<dd><p> 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.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="offsetToMark" class="membertitle">offsetToMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>offsetToMark</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom"> nMark )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="IOException.html">IOException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the offset from the current stream position to the
mark ("current position" - "mark position").
</dd>
<dt><b>Parameter nMark</b></dt>
<dd>identifies the mark which is used as a base
to calculate the offset of the current position.
</dd>
<dt><b>Throws</b></dt>
<dd>IllegalArgumentException
if the mark does not exist or is deleted.
</dd>
<dt><b>Throws</b></dt>
<dd>IOException
if an I/O error has occurred.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
3943
