LibreOffice 24.2 SDK API Reference
List of all members
StorageFactory Service Referencepublished

The StorageFactory is a service that allows to create a storage based on either stream or URL. More...


Inheritance diagram for StorageFactory:
XSingleServiceFactory XInterface

Additional Inherited Members

- Public Member Functions inherited from XSingleServiceFactory
com::sun::star::uno::XInterface createInstance () raises ( com::sun::star::uno::Exception )
 Creates an instance of a service implementation. More...
com::sun::star::uno::XInterface createInstanceWithArguments ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 Creates an instance of a service implementation initialized with some arguments. More...
- 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...

Detailed Description

The StorageFactory is a service that allows to create a storage based on either stream or URL.

In case com::sun::star::lang::XSingleServiceFactory::createInstance() call is used the result storage will be open in read-write mode based on an arbitrary medium.

In case com::sun::star::lang::XSingleServiceFactory::createInstanceWithArguments() call is used a sequence of the following parameters can be used:

parameter 1

specifies source of the object, it can be a string containing URL, an com::sun::star::io::XStream implementation or com::sun::star::io::XInputStream; in case of com::sun::star::io::XStream implementation the com::sun::star::io::XSeekable interface must be supported.

parameter 2

specifies mode the storage should be open in, can take values from ElementModes constant set.

parameter 3
this parameter represents any containing a sequence of com::sun::star::beans::PropertyValue.
The parameter can contain entries from com::sun::star::document::MediaDescryptor to transport some document info during the storage initialization, it can be for example com::sun::star::task::XInteractionHandler implementation, password for the storage and repair package flag.
Additionally the parameter might contain property with the name "StorageFormat" that can take values from com::sun::star::embed::StorageFormats. If the property is not provided a storage of package format is created.

The parameters are optional, that means that sequence can be empty or contain only first parameter, or first and second one. In case no parameters are provided the call works the same way as com::sun::star::lang::XSingleServiceFactory::createInstance(). In case only first parameter is provided, the storage is opened in readonly mode.

The opened root storage can support read access in addition to specified one.

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