interface XSimpleRegistry in module com::sun::star::registry::

(Global Index)

Syntax

interface XSimpleRegistry : com::sun::star::uno::XInterface ;

Description

Method 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.

Known Services Which Export this Interface

com::sun::star::registry::NestedRegistry

com::sun::star::registry::DefaultRegistry

com::sun::star::registry::SimpleRegistry

com::sun::star::registry::NestedRegistry

com::sun::star::registry::DefaultRegistry

com::sun::star::registry::SimpleRegistry

com::sun::star::configuration::ConfigurationRegistry

Method Details



getURL

Syntax

string getURL ();

Description

returns the URL of the current data source of the registry.


open

Syntax

void open (
string rURL,
boolean bReadOnly,
boolean bCreate )
raises ( com::sun::star::registry::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

Syntax

boolean isValid ();

Description

checks if the registry points to a valid data-source.


close

Syntax

void close ();
raises ( com::sun::star::registry::InvalidRegistryException );

Description

disconnects the registry from the data-source.

Throws

InvalidRegistryException if the registry is not open.

destroy

Syntax

void destroy ();
raises ( com::sun::star::registry::InvalidRegistryException );

Description

destroys the registry and the data source.

Throws

InvalidRegistryException if the registry is not open.

getRootKey

Syntax

com::sun::star::registry::XRegistryKey getRootKey ();
raises ( com::sun::star::registry::InvalidRegistryException );

Returns

the root key of the registry.

Throws

InvalidRegistryException if no registry is open

isReadOnly

Syntax

boolean isReadOnly ();
raises ( com::sun::star::registry::InvalidRegistryException );

Description

checks if the registry is readonly.

Throws

InvalidRegistryException if the registry is not open.

mergeKey

Syntax

void mergeKey (
string aKeyName,
string aUrl )
raises ( com::sun::star::registry::InvalidRegistryException , com::sun::star::registry::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