<html> <head> <title>Interface XStorage</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="XStorage-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 XStorage</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XStorage</strong> ┣ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> ┃ ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XElementAccess.html">XElementAccess</a> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to get list of child elements and to check if an element with a specified name exists in a storage. </dd> <dd><p> It is also possible to use this interface to get read access to a child element by <method scope="com::sun::star::container">XNameAccess::getByName</method> call. But the recommended way is to use <a href="XStorage.html">XStorage</a> interface for this purpose. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to controll and track lifetime of the storage. </dd> <dd><p> In case a storage is disposed any call to it's methods should result in ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/DisposedException.html">DisposedException</a>. </p> </dd> </dl> </td> </tr> </table> </dd> </dl> </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="#copyToStorage">copyToStorage</a></td> <td class="imsum_right">allows to copy current storage to another one </td> </tr> <tr> <td class="imsum_left"><a href="#openStreamElement">openStreamElement</a></td> <td class="imsum_right">allows to get access to a child stream of the storage. </td> </tr> <tr> <td class="imsum_left"><a href="#openEncryptedStreamElement">openEncryptedStreamElement</a></td> <td class="imsum_right">allows to get access to a child encrypted stream with password. </td> </tr> <tr> <td class="imsum_left"><a href="#openStorageElement">openStorageElement</a></td> <td class="imsum_right">allows to get access to a child storage. </td> </tr> <tr> <td class="imsum_left"><a href="#cloneStreamElement">cloneStreamElement</a></td> <td class="imsum_right">allows to get readonly copy of a child stream of the storage. </td> </tr> <tr> <td class="imsum_left"><a href="#cloneEncryptedStreamElement">cloneEncryptedStreamElement</a></td> <td class="imsum_right">allows to get readonly copy of a child encrypted stream with password. </td> </tr> <tr> <td class="imsum_left"><a href="#copyLastCommitTo">copyLastCommitTo</a></td> <td class="imsum_right">allows to get copy of this storage at the state of it's last commit. </td> </tr> <tr> <td class="imsum_left"><a href="#copyStorageElementLastCommitTo">copyStorageElementLastCommitTo</a></td> <td class="imsum_right">allows to get copy of a child storage at the state of it's last commit. </td> </tr> <tr> <td class="imsum_left"><a href="#isStreamElement">isStreamElement</a></td> <td class="imsum_right">allows to check if an element is a child stream with specified name. </td> </tr> <tr> <td class="imsum_left"><a href="#isStorageElement">isStorageElement</a></td> <td class="imsum_right">allows to check if an element is a child storage with specified name. </td> </tr> <tr> <td class="imsum_left"><a href="#removeElement">removeElement</a></td> <td class="imsum_right">removes an element from a storage. </td> </tr> <tr> <td class="imsum_left"><a href="#renameElement">renameElement</a></td> <td class="imsum_right">renames an element in a storage. </td> </tr> <tr> <td class="imsum_left"><a href="#copyElementTo">copyElementTo</a></td> <td class="imsum_right">allows to copy an entry from one storage to another. </td> </tr> <tr> <td class="imsum_left"><a href="#moveElementTo">moveElementTo</a></td> <td class="imsum_right">allows to move an entry from one storage to another. </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="copyToStorage" class="membertitle">copyToStorage</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>copyToStorage</b>(</td> <td valign="top">[in] <a href="XStorage.html">XStorage</a></td> <td valign="bottom"> xDest )</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="../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 copy current storage to another one </dd> <dd><p> The destination storage contents are overwritten. After the successful copying the target storage is automatically commited if it implements transacted access. </p> </dd> <dt><b>Parameter xDest</b></dt> <dd>a destination storage this storage must be copied to. </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 an illegal argument is provided </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case of io errors during copying </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::StorageWrappedTargetException wraps other exception acquired during copying </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="openStreamElement" class="membertitle">openStreamElement</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/XStream.html">XStream</a></td> </tr> <tr> <td valign="top"><b>openStreamElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sStreamName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nOpenMode )</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/WrongPasswordException.html">WrongPasswordException</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 access to a child stream of the storage. </dd> <dd><p> In case the stream is open in readonly mode the <method scope="com::sun::star::io">XStream::getOutputStream</method> method will return an empty reference. </p> </dd> <dt><b>Parameter sStreamName</b></dt> <dd>the name of the substream that should be open </dd> <dt><b>Parameter nOpenMode</b></dt> <dd>a mode the stream should be open in, can be a combination of <a href="ElementModes.html">ElementModes</a> values </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::WrongPasswordException the provided password is wrong </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="openEncryptedStreamElement" class="membertitle">openEncryptedStreamElement</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/XStream.html">XStream</a></td> </tr> <tr> <td valign="top"><b>openEncryptedStreamElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sStreamName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nOpenMode,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sPassword )</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="../packages/module-ix.html">packages</a>::<a href="../packages/WrongPasswordException.html">WrongPasswordException</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 access to a child encrypted stream with password. </dd> <dd><p> If storage does not allow any encryption this method will always throw ::com::sun::star::<a href="../packages/module-ix.html">packages</a>::<a href="../packages/NoEncryptionException.html">NoEncryptionException</a>. </p> <p> In case the stream is open in readonly mode the <method scope="com::sun::star::io">XStream::getOutputStream</method> method will return an empty reference. </p> </dd> <dt><b>Parameter sStreamName</b></dt> <dd>the name of the substream that should be open </dd> <dt><b>Parameter nOpenMode</b></dt> <dd>a mode the stream should be open in, can be a combination of <a href="ElementModes.html">ElementModes</a> values </dd> <dt><b>Parameter sPassword</b></dt> <dd>this parameter allowes to specify a reading password for the stream, the password must be a correct one, otherwise an exception will be thrown </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 encrypted </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::packages::WrongPasswordException the provided password is wrong </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="openStorageElement" class="membertitle">openStorageElement</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"><a href="XStorage.html">XStorage</a></td> </tr> <tr> <td valign="top"><b>openStorageElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sStorName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nOpenMode )</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="../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 access to a child storage. </dd> <dd><p> The opened substorage must support specified in 'nOpenMode' access modes. It can support 'read' mode in addition. But any child element can support one of those modes only in case this mode is supported by parent storage. </p> </dd> <dt><b>Parameter sStorName</b></dt> <dd>the name of the storage that should be open </dd> <dt><b>Parameter nOpenMode</b></dt> <dd>a mode the storage should be open in </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::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="cloneStreamElement" class="membertitle">cloneStreamElement</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/XStream.html">XStream</a></td> </tr> <tr> <td valign="top"><b>cloneStreamElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> 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/WrongPasswordException.html">WrongPasswordException</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 readonly copy of a child stream of the storage. </dd> <dd><p> The stream is open in readonly mode so the <method scope="com::sun::star::io">XStream::getOutputStream</method> method will return an empty reference. </p> </dd> <dt><b>Parameter sStreamName</b></dt> <dd>the name of the substream that should be copied </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::WrongPasswordException the provided password is wrong </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="cloneEncryptedStreamElement" class="membertitle">cloneEncryptedStreamElement</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/XStream.html">XStream</a></td> </tr> <tr> <td valign="top"><b>cloneEncryptedStreamElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sStreamName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sPassword )</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="../packages/module-ix.html">packages</a>::<a href="../packages/WrongPasswordException.html">WrongPasswordException</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 readonly copy of a child encrypted stream with password. </dd> <dd><p> If storage does not allow any encryption this method will always throw ::com::sun::star::<a href="../packages/module-ix.html">packages</a>::<a href="../packages/NoEncryptionException.html">NoEncryptionException</a>. </p> <p> The stream is open in readonly mode so the <method scope="com::sun::star::io">XStream::getOutputStream</method> method will return an empty reference. </p> <p> This method allows to specify reading password for the child stream explicitly. </p> </dd> <dt><b>Parameter sStreamName</b></dt> <dd>the name of the substream that should be copied </dd> <dt><b>Parameter sPassword</b></dt> <dd>this parameter allowes to specify a reading password for the stream, the password must be a correct one, otherwise an exception will be thrown </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 encrypted </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::packages::WrongPasswordException the provided password is wrong </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="copyLastCommitTo" class="membertitle">copyLastCommitTo</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>copyLastCommitTo</b>(</td> <td valign="top">[in] <a href="XStorage.html">XStorage</a></td> <td valign="bottom"> xTargetStorage )</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="../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 copy of this storage at the state of it's last commit. </dd> <dd><p> This method makes sence only for services implementations that allow transaction in the storage. </p> </dd> <dt><b>Parameter xStorage</b></dt> <dd>the target storage that will be filled in with copy. </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::io::IOException in case of io errors during copying </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="copyStorageElementLastCommitTo" class="membertitle">copyStorageElementLastCommitTo</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>copyStorageElementLastCommitTo</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sStorName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XStorage.html">XStorage</a></td> <td valign="bottom"> xTargetStorage )</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="../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 copy of a child storage at the state of it's last commit. </dd> <dd><p> This method makes sence only for services implementations that allow transaction in the storage. </p> </dd> <dt><b>Parameter sStorName</b></dt> <dd>the name of the storage that should be copied </dd> <dt><b>Parameter xStorage</b></dt> <dd>the target storage that will be filled in with copy </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::io::IOException in case of io errors during copying </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="isStreamElement" class="membertitle">isStreamElement</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">boolean</td> </tr> <tr> <td valign="top"><b>isStreamElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sElementName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="InvalidStorageException.html">InvalidStorageException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to check if an element is a child stream with specified name. </dd> <dd><p> In case there is no child element with such name an exception will be thrown. </p> </dd> <dt><b>Parameter sElementName</b></dt> <dd>the name of the element to check </dd> <dt><b>Returns</b></dt> <dd><b>true</b> in case the element is a stream <b>false</b> - the element is a storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException there is no element with such name </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException an illegal argument is provided </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isStorageElement" class="membertitle">isStorageElement</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">boolean</td> </tr> <tr> <td valign="top"><b>isStorageElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sElementName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="InvalidStorageException.html">InvalidStorageException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to check if an element is a child storage with specified name. </dd> <dd><p> In case there is no child element with such name an exception will be thrown. </p> </dd> <dt><b>Parameter sElementName</b></dt> <dd>the name of the element to check </dd> <dt><b>Returns</b></dt> <dd><b>true</b> in case the element is a storage <b>false</b> - the element is a stream </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException there is no element with such name </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException an illegal argument is provided </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeElement" class="membertitle">removeElement</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>removeElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sElementName )</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>removes an element from a storage. </dd> <dt><b>Parameter sElementName</b></dt> <dd>the name of the element to remove </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::InvalidStorageException this storage is in invalid state for eny reason </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException an illegal argument is provided </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException there is no element with such name </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case of io errors during removing </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="renameElement" class="membertitle">renameElement</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>renameElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sElementName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sNewName )</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="../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>renames an element in a storage. </dd> <dt><b>Parameter sElementName</b></dt> <dd>the old name of the element to rename </dd> <dt><b>Parameter sNewName</b></dt> <dd>the new name of the element to rename </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::InvalidStorageException this storage is in invalid state for eny reason </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException an illegal argument is provided </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException there is no element with old name in this storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::ElementExistException an element with new name already exists in this storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case of io errors during renaming </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="copyElementTo" class="membertitle">copyElementTo</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>copyElementTo</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sElementName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XStorage.html">XStorage</a></td> <td valign="bottom"> xDest,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sNewName )</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="../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 copy an entry from one storage to another. </dd> <dd><p> If target element supports transacted mode it must be commited by this method after successful copying. </p> </dd> <dt><b>Parameter sElementName</b></dt> <dd>the name of the element in this storage </dd> <dt><b>Parameter xDest</b></dt> <dd>a destination storage </dd> <dt><b>Parameter sNewName</b></dt> <dd>the name of the result element in destination storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::InvalidStorageException this storage is in invalid state for eny reason </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException there is no specified source element in this storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::ElementExistException an element with specified destination name already exists in destination storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case of io errors during copying </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="moveElementTo" class="membertitle">moveElementTo</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>moveElementTo</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sElementName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XStorage.html">XStorage</a></td> <td valign="bottom"> xDest,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sNewName )</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="../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 move an entry from one storage to another. </dd> <dd><p> If target element supports transacted mode it must be commited by this method after successful moving. </p> </dd> <dt><b>Parameter sElementName</b></dt> <dd>the name of the element in this storage </dd> <dt><b>Parameter xDest</b></dt> <dd>a destination storage </dd> <dt><b>Parameter sNewName</b></dt> <dd>the name of the result element in destination storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::embed::InvalidStorageException this storage is in invalid state for eny reason </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException there is no specified source element in this storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::ElementExistException an element with specified destination name already exists in destination storage </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case of io errors during moving </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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2991
