<html>
<head>
<title>Interface XStorageBasedLibraryContainer</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="XStorageBasedLibraryContainer-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="#AttributesSummary" class="navisub">Attributes' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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">script</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 XStorageBasedLibraryContainer</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XStorageBasedLibraryContainer</strong>
┗ <a href="XPersistentLibraryContainer.html">XPersistentLibraryContainer</a>
┣ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifiable.html">XModifiable</a>
┃ ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a>
┗ <a href="XLibraryContainer2.html">XLibraryContainer2</a>
┗ <a href="XLibraryContainer.html">XLibraryContainer</a>
┗ ::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>
</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XPersistentLibraryContainer.html">XPersistentLibraryContainer</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>describes a container of script libraries which is persistent.
</dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>is the interface for an <a href="XLibraryContainer.html">XLibraryContainer</a> which can be made
persistent in an ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a>.
</dd>
<dd><p>A persistent library container is associated with a root storage. The
container is responsible for a particular sub storage of the root storage,
the container storage.</p>
</dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.3</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="#storeLibrariesToStorage">storeLibrariesToStorage</a></td>
<td class="imsum_right">stores the libraries to a storage other than the current container storage
</td>
</tr>
</table>
<a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Attributes' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#RootStorage">RootStorage</a></td>
<td class="imsum_right">denotes the root storage associated with the container.
</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="storeLibrariesToStorage" class="membertitle">storeLibrariesToStorage</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>storeLibrariesToStorage</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a></td>
<td valign="bottom"> RootStorage )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>stores the libraries to a storage other than the current container storage
</dd>
<dd><p>Note that the library continer is not automatically associated with the
new root storage. Instead, you need to manually set the ::RootStroage
attribute afterwards. This separation allows for Save-To as well Save-As
operations.</p>
</dd>
<dt><b>Parameter RootStorage</b></dt>
<dd>denotes the root storage into which the libraries should be written, which
must not be <b>NULL</b>.<br/>
Note that the actual libraries are written into a sub storage of this
root storage, as usual.
</dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::IllegalArgumentException
if the <code>RootStorage</code> parameter is <b>NULL</b>, or equals
<a href="#RootStorage">RootStorage</a>.
</dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::WrappedTargetException
if an error occurs during storing.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Attributes' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="RootStorage" class="membertitle">RootStorage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a> <b>RootStorage</b><dl>
<dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd>
</dl>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>denotes the root storage associated with the container.
</dd>
<dd><p>Effectively, this attribute is a typed version of
<a href="XPersistentLibraryContainer.html">XPersistentLibraryContainer</a>::<a href="XPersistentLibraryContainer.html#RootLocation">RootLocation</a>, it's guaranteed
that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and
<code>RootStorage</code> have the same value.</p>
<p>You should only <em>set</em> this attribute to a new value if you previously
called storeLibrariesToStorage with the same storage. Setting this attribute
to a storage into which the container has not been stored previously might
result in unexpected behaviour.</p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
5087
