Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 2993

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XStorageRawAccess</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="XStorageRawAccess-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">embed</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XStorageRawAccess</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>This interface represents main storage functionality.
 </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="#getPlainRawStreamElement">getPlainRawStreamElement</a></td>
<td class="imsum_right">allows to get a plain raw stream representing a package stream.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getRawEncrStreamElement">getRawEncrStreamElement</a></td>
<td class="imsum_right">allows to get a raw stream representing encrypted stream with header.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#insertRawEncrStreamElement">insertRawEncrStreamElement</a></td>
<td class="imsum_right">allows to insert a raw stream representing encrypted stream with
 header.

 &nbsp;</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="getPlainRawStreamElement" class="membertitle">getPlainRawStreamElement</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">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
</tr>
<tr>
<td valign="top"><b>getPlainRawStreamElement</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;sStreamName )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="InvalidStorageException.html">InvalidStorageException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br>
::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br>
<a href="StorageWrappedTargetException.html">StorageWrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>allows to get a plain raw stream representing a package stream.

 </dd>
<dd><p>
 This method returns a stream from the package as it is stored there,
 without any decompression/decription and etc. This method can be
 helpful to check file consistency, for example by signing.
 </p>

 </dd>
<dt><b>Returns</b></dt>
<dd>the raw representation of encrypted stream with all the data
 required to copy the stream without information loss

 </dd>
<dt><b>Parameter sStreamName</b></dt>
<dd>the name of the substream that should be open
 
 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::embed::InvalidStorageException
 this storage is in invalid state for any reason

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 one of provided arguments is illegal

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::container::NoSuchElementException
 there is no element with specified name 

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::io::IOException
 in case of io errors during stream opening

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::embed::StorageWrappedTargetException
 wraps other exceptions
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getRawEncrStreamElement" class="membertitle">getRawEncrStreamElement</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">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
</tr>
<tr>
<td valign="top"><b>getRawEncrStreamElement</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;sStreamName )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="InvalidStorageException.html">InvalidStorageException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../packages/module-ix.html">packages</a>::<a href="../packages/NoEncryptionException.html">NoEncryptionException</a>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br>
::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br>
<a href="StorageWrappedTargetException.html">StorageWrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>allows to get a raw stream representing encrypted stream with header.

 </dd>
<dd><p>
 This method allows to transport encrypted streams without decryption.
 Mainly this method is introduced to allow to copy one encrypted
 storage stream to another without decryption. It is not reccomended to
 use this method outside of storage implementation since different
 storages implementation could have different encryption format. If the
 method is used outside of storage implementation the user code is
 resposible to get sure that the raw format of source and target
 storages is the same.
 </p>

 <p>
 The difference of this method from the previous one is that it handles
 only encrypted streams. The contents of returned by these methods
 streams can differ for the same entry, since this method can add
 additional data into the stream to allow successful insertion.
 </p>

 </dd>
<dt><b>Parameter sStreamName</b></dt>
<dd>the name of the substream that should be open
 
 </dd>
<dt><b>Parameter xInputStream</b></dt>
<dd>a raw stream representing encrypted stream

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::embed::InvalidStorageException
 this storage is in invalid state for any reason

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 one of provided arguments is illegal

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::packages::NoEncryptionException
 the stream is not an encrypted one

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::container::NoSuchElementException
 there is no element with specified name 

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::io::IOException
 in case of io errors during stream opening

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::embed::StorageWrappedTargetException
 wraps other exceptions
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="insertRawEncrStreamElement" class="membertitle">insertRawEncrStreamElement</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>insertRawEncrStreamElement</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;sStreamName,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
<td valign="bottom">&nbsp;xInStream )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="InvalidStorageException.html">InvalidStorageException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../packages/module-ix.html">packages</a>::<a href="../packages/NoRawFormatException.html">NoRawFormatException</a>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a>,<br>
::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br>
<a href="StorageWrappedTargetException.html">StorageWrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>allows to insert a raw stream representing encrypted stream with
 header.

 </dd>
<dd><p>
 This method allows to insert a stream retrived by
 <method>XStorageRawAccess::getRawEncrStreamElement()</method> into a
 storage.
 </p>

 <p>
 This method allows to transport encrypted streams without decryption.
 Mainly this method is introduced to allow to copy one encrypted
 storage stream to another without decryption. It is not reccomended to
 use this method outside of storage implementation since different
 storages implementation could have different encryption format.
 </p>

 </dd>
<dt><b>Parameter sStreamName</b></dt>
<dd>the name of the substream that should be open
 
 </dd>
<dt><b>Parameter xInputStream</b></dt>
<dd>a raw stream representing encrypted stream

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::embed::InvalidStorageException
 this storage is in invalid state for any reason

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
 one of provided arguments is illegal

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::packages::NoRawFormatException
 the stream is not one of raw package stream format

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::container::ElementExistException
 an element with specified name already exists

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::io::IOException
 in case of io errors during stream opening

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::embed::StorageWrappedTargetException
 wraps other exceptions
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>