LibreOffice LibreOffice 26.2 SDK API Reference

List of all members
FileSystemStorageFactory Service Referencepublished

The FileSystemStorageFactory is a service that allows to create a FileSystemStorage based on URL. More...

`import"FileSystemStorageFactory.idl";`

Inheritance diagram for FileSystemStorageFactory:

## 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 FileSystemStorageFactory is a service that allows to create a FileSystemStorage based on URL.

The URL must point to a folder.

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 file system folder.

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 must be a string containing URL.

parameter 2

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

parameter 3
  allows to provide com::sun::star::document::MediaDescryptor to the storage so some parts can be used for initialization, it can be for example com::sun::star::task::XInteractionHandler implementation.

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 storages can support read access in addition to specified one.

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

- com/sun/star/embed/FileSystemStorageFactory.idl