LibreOffice LibreOffice 25.8 SDK API Reference

Exported Interfaces | List of all members
DefaultRegistry Service Referencepublished

implicitly supports a local registry and a read-only system registry for global information. More...

`import"DefaultRegistry.idl";`

Inheritance diagram for DefaultRegistry:

## Exported Interfaces
interface | com::sun::star::registry::XSimpleRegistry

## 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 )
| merges a registry under the specified key. 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

implicitly supports a local registry and a read-only system registry for global information.

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 the local registry.
isValid
  checks if the local registry is valid. If the interface is not `NULL` the local registry should always be valid.
isReadOnly
  checks if the local registry has write protection.
mergeKey
  merges all information from the specified registry in the local registry.
getRootKey
  returns a virtual rootkey of both registries.

Functions of XRegistryKey:

openKey
  returns a virtual key which is specified in the local or the system registry.
deleteKey
  deletes the key only if it is present in the local registry.
setLongValue, setAsciiValue, setStringValue, setBinaryValue
  sets the value at the specified key in the local registry.
getLongValue, getAsciiValue, getStringValue, getBinaryValue
  returns the value at the specified key in the local registry, or if the value is not present in the local registry, it will return the value of the system registry.
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 the local registry.

How to find the registries:

search for the system registry:
  The system registry will always be searched in the same directory as the executable. The name of the system registry is "applicat.rdb". If the system registry was not found, then the environment variable STAR_REGISTRY will be checked. If this variable was set, it must contain a full path to a valid system registry.
Search for the user registry using the following rules:
  1. 1. (for further use) search in sversion.ini (.sversionrc) for an entry REGISTRY_VERSION_STRING (example: UserRegistry 5.0/505=test.rdb) in the section [Registry]. If found, then take this value instead of "user.rdb" as "REGISTRY NAME".
  2. 2. Search in the config directory of the user for a file "REGISTRY NAME". If found, return the full path and name of the file. If not found, retry this step with a dot before "REGISTRY NAME".
  3. 3. If not found, a new user registry with name user.rdb will be created in the user config directory.

#### Guarantees:

- -thread safe

## Exported Interfaces

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

interface com::sun::star::registry::XSimpleRegistry

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

- com/sun/star/registry/DefaultRegistry.idl