LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
ConfigurationRegistry Service Referencepublished

import"ConfigurationRegistry.idl";

Inheritance diagram for ConfigurationRegistry:
XSimpleRegistry XFlushable XInterface XInterface

Exported Interfaces

interface com::sun::star::registry::XSimpleRegistry
 controls the binding of the object to a configuration sub tree. More...
 
interface com::sun::star::util::XFlushable
 is used to commit changes to the configuration. More...
 

Additional Inherited Members

- Public Member Functions inherited from XSimpleRegistry
string getURL ()
 returns the URL of the current data source of the registry. More...
 
void open ([in] string rURL, [in] boolean bReadOnly, [in] boolean bCreate) raises ( com::sun::star::registry::InvalidRegistryException )
 connects the registry to a persistent data source represented by an URL. More...
 
boolean isValid ()
 checks if the registry points to a valid data-source. More...
 
void close () raises ( com::sun::star::registry::InvalidRegistryException )
 disconnects the registry from the data-source. More...
 
void destroy () raises ( com::sun::star::registry::InvalidRegistryException )
 destroys the registry and the data source. More...
 
com::sun::star::registry::XRegistryKey getRootKey () raises ( com::sun::star::registry::InvalidRegistryException )
 
boolean isReadOnly () raises ( com::sun::star::registry::InvalidRegistryException )
 checks if the registry is readonly. More...
 
void mergeKey ([in] string aKeyName, [in] string aUrl) raises ( com::sun::star::registry::InvalidRegistryException, com::sun::star::registry::MergeConflictException )
 DEPRECATED: this method lacks a registry key (better than a URL). 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...
 
- Public Member Functions inherited from XFlushable
void flush ()
 flushes the data of the object to the connected data source. More...
 
void addFlushListener ([in] com::sun::star::util::XFlushListener l)
 adds the specified listener to receive event "flushed." More...
 
void removeFlushListener ([in] com::sun::star::util::XFlushListener l)
 removes the specified listener. More...
 

Exported Interfaces

controls the binding of the object to a configuration sub tree.

com::sun::star::registry::XSimpleRegistry::open() is used to open a special subtree within the configuration tree.

The parameters of this method control the location of the root of the to-be-opened configuration node and the access mode (read only or updatable).

is used to commit changes to the configuration.

As specified for the com::sun::star::configuration::ConfigurationUpdateAccess service, all changes made to an configuration subtree have to be committed before they become persistent. To do this for a configuration accessed as a registry, call com::sun::star::util::XFlushable::flush().

Warning:Changes that are not flushed will be lost.


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