XStorage2 Interface Reference

This interface extends the base XStorage interface. More...

import"XStorage2.idl";

Inheritance diagram for XStorage2:

Public Member Functions
::com::sun::star::io::XStream	openEncryptedStream ([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::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to get access to a child encrypted stream with EncryptionData. More...
::com::sun::star::io::XStream	cloneEncryptedStream ([in] string sStreamName, [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::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to get readonly copy of a child encrypted stream with encryption data. More...
Public Member Functions inherited from XStorage
void	copyToStorage ([in] XStorage xDest) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to copy current storage to another one More...
::com::sun::star::io::XStream	openStreamElement ([in] string sStreamName, [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. More...
::com::sun::star::io::XStream	openEncryptedStreamElement ([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. More...
XStorage	openStorageElement ([in] string sStorName, [in] long nOpenMode) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to get access to a child storage. More...
::com::sun::star::io::XStream	cloneStreamElement ([in] string sStreamName) 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 readonly copy of a child stream of the storage. More...
::com::sun::star::io::XStream	cloneEncryptedStreamElement ([in] string sStreamName, [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 readonly copy of a child encrypted stream with password. More...
void	copyLastCommitTo ([in] XStorage xTargetStorage) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to get copy of this storage at the state of its last commit. More...
void	copyStorageElementLastCommitTo ([in] string sStorName, [in] XStorage xTargetStorage) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to get copy of a child storage at the state of its last commit. More...
boolean	isStreamElement ([in] string sElementName) raises ( ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::embed::InvalidStorageException )
	allows to check if an element is a child stream with specified name. More...
boolean	isStorageElement ([in] string sElementName) raises ( ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::embed::InvalidStorageException )
	allows to check if an element is a child storage with specified name. More...
void	removeElement ([in] string sElementName) 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 an element from a storage. More...
void	renameElement ([in] string sElementName, [in] string sNewName) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::container::ElementExistException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	renames an element in a storage. More...
void	copyElementTo ([in] string sElementName, [in] XStorage xDest, [in] string sNewName) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::container::ElementExistException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to copy an entry from one storage to another. More...
void	moveElementTo ([in] string sElementName, [in] XStorage xDest, [in] string sNewName) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::container::ElementExistException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to move an entry from one storage to another. More...
Public Member Functions inherited from XNameAccess
any	getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
sequence< string >	getElementNames ()
boolean	hasByName ([in] string aName)
Public Member Functions inherited from XElementAccess
type	getElementType ()
boolean	hasElements ()
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...
void	acquire ()
	increases the reference counter by one. More...
void	release ()
	decreases the reference counter by one. More...
Public Member Functions inherited from XComponent
void	dispose ()
	The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
void	addEventListener ([in] XEventListener xListener)
	adds an event listener to the object. More...
void	removeEventListener ([in] XEventListener aListener)
	removes an event listener from the listener list. More...

Additional Inherited Members
Exported Interfaces inherited from XStorage
interface	::com::sun::star::container::XNameAccess
	allows to get list of child elements and to check if an element with a specified name exists in a storage. More...
interface	::com::sun::star::lang::XComponent
	allows to control and track lifetime of the storage. More...

Detailed Description

This interface extends the base XStorage interface.

Member Function Documentation

cloneEncryptedStream()

::com::sun::star::io::XStream cloneEncryptedStream	(	[in] string	sStreamName,
		[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::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to get readonly copy of a child encrypted stream with encryption data.

If storage does not allow any encryption this method will always throw com::sun::star::packages::NoEncryptionException.

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

This method allows to specify encryption data for the child stream explicitly.

Parameters

sStreamName	the name of the substream that should be copied
aEncryptionData	this parameter allows to specify an encryption data for the stream, the encryption data must be correct, otherwise an exception will be thrown

Exceptions

com::sun::star::embed::InvalidStorageException	this storage is in invalid state for any reason
com::sun::star::lang::IllegalArgumentException	one of provided arguments is illegal
com::sun::star::packages::NoEncryptionException	the stream is not encrypted
com::sun::star::packages::WrongPasswordException	the provided encryption data is wrong
com::sun::star::io::IOException	in case of io errors during stream opening
com::sun::star::embed::StorageWrappedTargetException	wraps other exceptions

openEncryptedStream()

::com::sun::star::io::XStream openEncryptedStream	(	[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::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to get access to a child encrypted stream with EncryptionData.

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

sStreamName	the name of the substream that should be open
nOpenMode	a mode the stream should be open in, can be a combination of ElementModes values
aEncryptionData	this parameter allows to specify an encryption data to decrypt the stream, the encryption data must be correct, otherwise an exception will be thrown

Exceptions

com::sun::star::embed::InvalidStorageException	this storage is in invalid state for any reason
com::sun::star::lang::IllegalArgumentException	one of provided arguments is illegal
com::sun::star::packages::NoEncryptionException	the stream is not encrypted
com::sun::star::packages::WrongPasswordException	the provided encryption data is wrong
com::sun::star::io::IOException	in case of io errors during stream opening
com::sun::star::embed::StorageWrappedTargetException	wraps other exceptions

---

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

• com/sun/star/embed/XStorage2.idl