LibreOffice
LibreOffice 25.8 SDK API Reference
|
allows access to a registry (a persistent data source). More...
import "XSimpleRegistry.idl";
Public Member Functions | |
string | getURL () |
returns the URL of the current data source of the registry. | |
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. | |
boolean | isValid () |
checks if the registry points to a valid data-source. | |
void | close () raises ( com::sun::star::registry::InvalidRegistryException ) |
disconnects the registry from the data-source. | |
void | destroy () raises ( com::sun::star::registry::InvalidRegistryException ) |
destroys the registry and the data source. | |
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. | |
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. | |
Public Member Functions inherited from XInterface | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. | |
void | acquire () |
increases the reference counter by one. | |
void | release () |
decreases the reference counter by one. |
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.
void close | ( | ) | ||||
raises | ( | com::sun::star::registry::InvalidRegistryException ) |
disconnects the registry from the data-source.
InvalidRegistryException | if the registry is not open. |
void destroy | ( | ) | ||||
raises | ( | com::sun::star::registry::InvalidRegistryException ) |
destroys the registry and the data source.
InvalidRegistryException | if the registry is not open. |
com::sun::star::registry::XRegistryKey getRootKey | ( | ) | ||||
raises | ( | com::sun::star::registry::InvalidRegistryException ) |
InvalidRegistryException | if no registry is open |
string getURL | ( | ) |
returns the URL of the current data source of the registry.
boolean isReadOnly | ( | ) | ||||
raises | ( | com::sun::star::registry::InvalidRegistryException ) |
checks if the registry is readonly.
InvalidRegistryException | if the registry is not open. |
boolean isValid | ( | ) |
checks if the registry points to a valid data-source.
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.
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.
If a local registry is already open, this function will close the currently open registry.
rURL | specifies the complete URL to access the data source. |
bReadOnly | specifies if the data source should be opened for read only. |
bCreate | specifies if the data source should be created if it does not already exist. |
InvalidRegistryException | if the registry does not exist. |