Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.13

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: embed ::

unpublished interface XHierarchicalStorageAccess2
Base Interfaces
XHierarchicalStorageAccess2XHierarchicalStorageAccess

XHierarchicalStorageAccess
(referenced interface's summary:)
This interface allows hierarchical access to storage tree.
Usage Restrictions
not published
Description
This interface extends XHierarchicalStorageAccess interface.

Methods' Summary
openEncryptedStreamByHierarchicalName allows to get access to a child encrypted stream with encryption data using hierarchical path.  
Methods' Details
openEncryptedStreamByHierarchicalName
XExtendedStorageStream
openEncryptedStreamByHierarchicalName( [in] string  sStreamName,
[in] long  nOpenMode,
[in] sequence< ::com::sun::star::beans::NamedValue >  aEncryptionData )
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 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 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 aEncryptionData
this parameter allowes to specify an encryption data for the stream, the data must be correct, 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
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.