Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

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

Exported Interfaces - Summary
::com::sun::star::lang::XSingleServiceFactory

A storage can be created through this interface. (details)

Exported Interfaces - Details
::com::sun::star::lang::XSingleServiceFactory
Description
A storage can be created through this interface.

In case XSingleServiceFactory::createInstance call is used the result storage will be open in readwrite mode based on an arbitrary medium.

In case 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 paramenter represents com::sun::star::uno::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.
Additionaly the parameter might contain property with the name "StorageFormat" that can take values from 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.


 
Top of Page

Apache Software Foundation

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

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