LibreOffice
LibreOffice 7.2 SDK API Reference
Public Member Functions | List of all members
XHierarchicalStorageAccess2 Interface Reference

This interface extends XHierarchicalStorageAccess interface. More...

import"XHierarchicalStorageAccess2.idl";

Inheritance diagram for XHierarchicalStorageAccess2:
XHierarchicalStorageAccess

Public Member Functions

XExtendedStorageStream openEncryptedStreamByHierarchicalName ([in] string sStreamName, [in] long nOpenMode, [in] sequence< ::com::sun::star::beans::NamedValue > aEncryptionData) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::packages::NoEncryptionException, ::com::sun::star::packages::WrongPasswordException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
 allows to get access to a child encrypted stream with encryption data using hierarchical path. More...
 
- Public Member Functions inherited from XHierarchicalStorageAccess
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 extends XHierarchicalStorageAccess interface.

Member Function Documentation

◆ openEncryptedStreamByHierarchicalName()

allows to get access to a child encrypted stream with encryption data 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
aEncryptionDatathis parameter allows to specify an encryption data for the stream, the data must be correct, 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

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