:: com :: sun :: star :: registry ::
|
interface XSimpleRegistry |
|
- Description
- 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.
- See also
- XRegistryKey
|
Methods' Summary |
getURL |
returns the URL of the current data source of the registry.
|
open |
connects the registry to a persistent data source represented by
an URL.
|
isValid |
checks if the registry points to a valid data-source.
|
close |
disconnects the registry from the data-source.
|
destroy |
destroys the registry and the data source.
|
getRootKey |
|
isReadOnly |
checks if the registry is readonly.
|
mergeKey |
DEPRECATED: this method lacks a registry key (better than a URL).
merges a registry under the specified key.
|
Methods' Details |
getURL
- Description
- returns the URL of the current data source of the registry.
|
|
open
- Description
- connects the registry to a persistent data source represented by
an URL.
If a local registry is already open, this function
will close the currently open registry.
- Parameter aURL
- specifies the complete URL to access the data source.
- Parameter bReadOnly
- specifies if the data source should be opened for
read only.
- Parameter bCreate
- specifies if the data source should be created if it
does not already exist.
- Throws
- InvalidRegistryException
if the registry does not exist.
|
|
isValid
- Description
- checks if the registry points to a valid data-source.
|
|
close
- Description
- disconnects the registry from the data-source.
- Throws
- InvalidRegistryException
if the registry is not open.
|
|
destroy
- Description
- destroys the registry and the data source.
- Throws
- InvalidRegistryException
if the registry is not open.
|
|
getRootKey
- Returns
- the root key of the registry.
- Throws
- InvalidRegistryException
if no registry is open
|
|
isReadOnly
- Description
- checks if the registry is readonly.
- Throws
- InvalidRegistryException
if the registry is not open.
|
|
mergeKey
- Description
- DEPRECATED: this method lacks a registry key (better than a URL).
merges a registry under the specified key.
If the key does not exist it will be created. Existing
keys will be overridden from keys of registry specified by
aUrl.
- Throws
- InvalidRegistryException
if the registry is not open.
- Throws
- MergeConflictException
if any differences occur during merging
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.