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 :: registry ::

service DefaultRegistry
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 sytem 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. (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. 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. If not found, a new user registry with name user.rdb will be created in the user config directory.

Guarantees:

  • -thread safe

Exported Interfaces - Summary
XSimpleRegistry
(referenced entity's summary:)
allows access to a registry (a persistent data source). The data is stored in a hierarchical key structure beginning with a root key. Each key can store a value and can have multiple subkeys.
Exported Interfaces - Details
XSimpleRegistry
(referenced entity's summary:)
allows access to a registry (a persistent data source). The data is stored in a hierarchical key structure beginning with a root key. Each key can store a value and can have multiple subkeys.

 
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.