Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: embed ::
interface XHierarchicalStorageAccess
Description This interface allows hierarchical access to storage tree. Currently only streams can be opened using this interface. The hierarchical access can not be mixed with a normal access. Thus when in a storage a stream with a path "a/b/c" is accessed using hierarchical access, another stream "a/b/d" can also be opened with hierarchical access ( if it is still not opened ), but the substorage "a" can not be opened ( it is locked by hierarchical access ).

Methods' Summary
openStreamElementByHierarchicalName | allows to get access to a child stream of the storage, using hierarchical path.
openEncryptedStreamElementByHierarchicalName | allows to get access to a child encrypted stream with password using hierarchical path.
removeStreamElementByHierarchicalName | removes a stream specified by hierarchical name from a storage.

Methods' Details
openStreamElementByHierarchicalName
XExtendedStorageStream
openStreamElementByHierarchicalName( | [in] string | sStreamPath,
| [in] long | nOpenMode )
raises( | InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::packages::WrongPasswordException, ::com::sun::star::io::IOException, StorageWrappedTargetException );
Description allows to get access to a child stream of the storage, using hierarchical path. In case the stream is open in readonly mode the XStream::getOutputStream method will return an empty reference. Parameter sStreamPath the path to the substream that should be open Parameter nOpenMode a mode the stream should be open in, can be a combination of ElementModes values Throws ::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason Throws ::com::sun::star::lang::IllegalArgumentException one of provided arguments is illegal Throws ::com::sun::star::packages::WrongPasswordException the provided password is wrong Throws ::com::sun::star::io::IOException in case of io errors during stream opening Throws ::com::sun::star::embed::StorageWrappedTargetException wraps other exceptions
openEncryptedStreamElementByHierarchicalName
XExtendedStorageStream
openEncryptedStreamElementByHierarchicalName( | [in] string | sStreamName,
| [in] long | nOpenMode,
| [in] string | sPassword )
raises( | InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::packages::NoEncryptionException, ::com::sun::star::packages::WrongPasswordException, ::com::sun::star::io::IOException, StorageWrappedTargetException );
Description allows to get access to a child encrypted stream with password using hierarchical path. If storage does not allow any encryption this method will always throw ::com::sun::star::packages::NoEncryptionException. In case the stream is open in readonly mode the XStream::getOutputStream method will return an empty reference. Parameter sStreamPath the path to the substream that should be open Parameter nOpenMode a mode the stream should be open in, can be a combination of ElementModes values Parameter sPassword this parameter allows to specify a reading password for the stream, the password must be a correct one, otherwise an exception will be thrown Throws ::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason Throws ::com::sun::star::lang::IllegalArgumentException one of provided arguments is illegal Throws ::com::sun::star::packages::NoEncryptionException the stream is not encrypted Throws ::com::sun::star::packages::WrongPasswordException the provided password is wrong Throws ::com::sun::star::io::IOException in case of io errors during stream opening Throws ::com::sun::star::embed::StorageWrappedTargetException wraps other exceptions
removeStreamElementByHierarchicalName
void
removeStreamElementByHierarchicalName( | [in] string | sElementPath )
raises( | InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::io::IOException, StorageWrappedTargetException );
Description removes a stream specified by hierarchical name from a storage. Parameter sElementPath the path to the element to remove Throws ::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason Throws ::com::sun::star::lang::IllegalArgumentException an illegal argument is provided Throws ::com::sun::star::container::NoSuchElementException there is no element with such name Throws ::com::sun::star::io::IOException in case of io errors during removing Throws ::com::sun::star::embed::StorageWrappedTargetException wraps other exceptions

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.