LibreOffice
LibreOffice 6.4 SDK API Reference
Exported Interfaces | List of all members
NestedRegistry Service Referencepublished

supports a shared view on two different registries. More...

import"NestedRegistry.idl";

Inheritance diagram for NestedRegistry:
XSimpleRegistry XInitialization XInterface XInterface

Exported Interfaces

interface com::sun::star::registry::XSimpleRegistry
 
interface com::sun::star::lang::XInitialization
 

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 a 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 XInitialization
void initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 initializes the object. More...
 

Detailed Description

supports a shared view on two different registries.

The registry files will be opened in two different modes, registry1 will be opened with read/write rights and registry2 will be opened read-only. In the context of this service, the functions open, close, and destroy from XSimpleRegistry are not supported and throw an exception if they are used.

Functions of XSimpleRegistry:

getURL

returns the name of registry1.

isValid

checks if registry1 is valid. If the interface is not NULL then registry1 should always be valid.

isReadOnly
checks if registry1 has write protection.
mergeKey

merges all information from the specified registry in registry1.

getRootKey
returns a virtual rootkey of both registries.

Functions of XRegistryKey:

openKey

returns a virtual key which is specified in registry1 or registry2.

deleteKey

deletes the key only if it is present in registry1.

setLongValue, setAsciiValue, setStringValue, setBinaryValue

sets the value at the specified key in registry1.

getLongValue, getAsciiValue, getStringValue, getBinaryValue

returns the value at the specified key in registry1, or if the value is not present in registry1, it will return the value of registry2.

openKeys

returns a sequence of all subkeys in both registries.

getKeyNames

returns a sequence with the names of all subkeys in both registries.

Note: all write functions only work on registry1.

How to initialize the registries:
Use a sequence of XSimpleRegistry with two elements. The first element must be the registry which is opened with read/write rights and the second element must be the read-only one.
Two different ways are possible:


Guarantees:

Exported Interfaces

◆ com::sun::star::lang::XInitialization

◆ com::sun::star::registry::XSimpleRegistry


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