Methods of Class Registry
-
Registry
- Registry(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Constructor using the registry Api directly.
- Description
- This constructor is called with a valid Api for the registry.
The constructor is used if the Api is known. Use open() or create()
to initialize the registry with a valid registry data file.
-
Registry
- Registry(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Constructor using the loader mechanism.
- Description
- This constructor is called with a RegisterLoader for the registry.
The RegistryLoader loads the needed DLL and provides the needed Api for
the registry. Use open() or create() to initialize the registry with a
valid registry data file.
-
Registry
- Registry(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Copy constructcor
-
~Registry
- ~Registry();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Destructor. The Destructor close the registry if it is open.
-
operator=
- Registry & operator=(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Assign operator
-
isValid
- sal_Bool isValid();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- checks if the registry points to a valid registry data file.
-
isReadOnly
- sal_Bool isReadOnly();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the access mode of the registry.
- Return
- TRUE if the access mode is readonly else FALSE.
-
openRootKey
- RegError openRootKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- opens the root key of the registry.
- Parameters
rRootKey |
reference to a RegistryKey which is filled with the rootkey.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
-
getName
- ::rtl::OUString getName();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the name of the current registry data file.
-
create
- RegError create(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- creates a new registry with the specified name and creates a root key.
- Parameters
registryName |
specifies the name of the new registry.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
-
open
- RegError open(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- opens a registry with the specified name.
- Description
- If the registry already points to a valid registry, the old registry will be closed.
- Parameters
registryName |
specifies a registry name.
|
accessMode |
specifies the access mode for the registry, REG_READONLY or REG_READWRITE.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
-
close
- RegError close();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- closes explicitly the current registry data file.
-
destroy
- RegError destroy(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- destroys a registry.
- Parameters
registryName |
specifies a registry name, if the name is an empty string the registry
itselfs will be destroyed.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
-
loadKey
- RegError loadKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- loads registry information from a specified file and save it under the
specified keyName.
- Parameters
rKey |
references a currently open key. The key which should store the registry information
is a subkey of this key.
|
keyName |
specifies the name of the key which stores the registry information. If keyName is
is an empty string the registry information will be saved under the key specified
by rKey.
|
regFileName |
specifies the file containing the registry information.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
-
saveKey
- RegError saveKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- saves the registry information of the specified key and all subkeys and save
it in the specified file.
- Parameters
rKey |
references a currently open key. The key which information is saved by this
function is a subkey of this key.
|
keyName |
specifies the name of the key which information should be stored.
If keyName is an empty string the registry information under the key specified
by rKey is saved in the specified file.
|
regFileName |
specifies the file containing the registry information.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
-
mergeKey
- RegError mergeKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- merges the registry information of the specified key with the registry
information of the specified file.
- Description
- All existing keys will be extended and existing key values will be overwritten.
- Parameters
rKey |
references a currently open key. The key which information is merged by this
function is a subkey of this key
|
keyName |
specifies the name of the key which will be merged.
If keyName is an empty string the registry information under the key specified
by rKey is merged with the information from the specified file.
|
regFileName |
specifies the file containing the registry information.
|
bWarnings |
if TRUE the function returns an error if a key already exists.
|
bReport |
if TRUE the function reports warnings on stdout if a key already exists.
|
- Return
- REG_NO_ERROR if succeeds else an error code. If it returns an error the registry will
restore the state before merging.
-
dumpRegistry
- RegError dumpRegistry(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- This function reports the complete registry information of a key and all of its subkeys.
- Description
- All information which are available (keynames, value types, values, linknames, linktargets, ...)
will be printed to stdout for report issues only.
- Parameters
rKey |
references a currently open key which content will be reported.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
-
getApi
- const Registry_Api * getApi();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the used registry Api.
Top of Page
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.