Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: 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
string
getURL();
Description
returns the URL of the current data source of the registry.
open
void
open( [in] string  rURL,
[in] boolean  bReadOnly,
[in] boolean  bCreate )
raises( InvalidRegistryException );
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
boolean
isValid();
Description
checks if the registry points to a valid data-source.
close
void
close()
raises( InvalidRegistryException );
Description
disconnects the registry from the data-source.
Throws
InvalidRegistryException if the registry is not open.
destroy
void
destroy()
raises( InvalidRegistryException );
Description
destroys the registry and the data source.
Throws
InvalidRegistryException if the registry is not open.
getRootKey
XRegistryKey
getRootKey()
raises( InvalidRegistryException );
Returns
the root key of the registry.
Throws
InvalidRegistryException if no registry is open
isReadOnly
boolean
isReadOnly()
raises( InvalidRegistryException );
Description
checks if the registry is readonly.
Throws
InvalidRegistryException if the registry is not open.
mergeKey
void
mergeKey( [in] string  aKeyName,
[in] string  aUrl )
raises( InvalidRegistryException,
MergeConflictException );
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.

The ASF

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The ASF logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.