LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XHierarchicalStorageAccess Interface Referencepublished

This interface allows hierarchical access to storage tree. More...

import"XHierarchicalStorageAccess.idl";

Inheritance diagram for XHierarchicalStorageAccess:
XHierarchicalStorageAccess2

Public Member Functions

XExtendedStorageStream openStreamElementByHierarchicalName ([in] string sStreamPath, [in] long nOpenMode) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::packages::WrongPasswordException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
 allows to get access to a child stream of the storage, using hierarchical path. More...
 
XExtendedStorageStream openEncryptedStreamElementByHierarchicalName ([in] string sStreamName, [in] long nOpenMode, [in] string sPassword) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::packages::NoEncryptionException, ::com::sun::star::packages::WrongPasswordException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
 allows to get access to a child encrypted stream with password using hierarchical path. More...
 
void removeStreamElementByHierarchicalName ([in] string sElementPath) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
 removes a stream specified by hierarchical name from a storage. More...
 

Detailed 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 ).

Member Function Documentation

◆ openEncryptedStreamElementByHierarchicalName()

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 com::sun::star::io::XStream::getOutputStream() method will return an empty reference.

Parameters
sStreamNamethe path to the substream that should be open
nOpenModea mode the stream should be open in, can be a combination of ElementModes values
sPasswordthis parameter allows to specify a reading password for the stream, the password must be a correct one, otherwise an exception will be thrown
Exceptions
com::sun::star::embed::InvalidStorageExceptionthis storage is in invalid state for any reason
com::sun::star::lang::IllegalArgumentExceptionone of provided arguments is illegal
com::sun::star::packages::NoEncryptionExceptionthe stream is not encrypted
com::sun::star::packages::WrongPasswordExceptionthe provided password is wrong
com::sun::star::io::IOExceptionin case of io errors during stream opening
com::sun::star::embed::StorageWrappedTargetExceptionwraps other exceptions

◆ openStreamElementByHierarchicalName()

allows to get access to a child stream of the storage, using hierarchical path.

In case the stream is open in readonly mode the com::sun::star::io::XStream::getOutputStream() method will return an empty reference.

Parameters
sStreamPaththe path to the substream that should be open
nOpenModea mode the stream should be open in, can be a combination of ElementModes values
Exceptions
com::sun::star::embed::InvalidStorageExceptionthis storage is in invalid state for any reason
com::sun::star::lang::IllegalArgumentExceptionone of provided arguments is illegal
com::sun::star::packages::WrongPasswordExceptionthe provided password is wrong
com::sun::star::io::IOExceptionin case of io errors during stream opening
com::sun::star::embed::StorageWrappedTargetExceptionwraps other exceptions

◆ removeStreamElementByHierarchicalName()

removes a stream specified by hierarchical name from a storage.

Parameters
sElementPaththe path to the element to remove
Exceptions
com::sun::star::embed::InvalidStorageExceptionthis storage is in invalid state for any reason
com::sun::star::lang::IllegalArgumentExceptionan illegal argument is provided
com::sun::star::container::NoSuchElementExceptionthere is no element with such name
com::sun::star::io::IOExceptionin case of io errors during removing
com::sun::star::embed::StorageWrappedTargetExceptionwraps other exceptions

The documentation for this interface was generated from the following file: