LibreOffice Module registry (master)  1
Classes | Namespaces | Macros | Typedefs | Enumerations | Variables
regtype.h File Reference
#include <sal/types.h>
#include <o3tl/typed_flags_set.hxx>
Include dependency graph for regtype.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  o3tl::typed_flags< RegAccessMode >
 

Namespaces

 o3tl
 

Macros

#define REGISTRY_CALLTYPE   SAL_CALL
 specify the calling convention for the registry API More...
 

Typedefs

typedef voidRegHandle
 defines the type of a registry handle used in the C API. More...
 
typedef voidRegKeyHandle
 defines the type of a registry key handle used in the C API. More...
 
typedef voidRegValue
 defines the type of a registry key value handle used in the C API. More...
 

Enumerations

enum  RegAccessMode {
  RegAccessMode::READONLY = 0x0001,
  RegAccessMode::READWRITE = 0x0002
}
 defines the open/access mode of the registry. More...
 

Variables

enum SAL_DLLPUBLIC_RTTI RegValueType
 defines the type of a key value. More...
 
 NOT_DEFINED
 The key has no value or the value type is unknown. More...
 
 LONG
 The key has a value of type long. More...
 
 STRING
 The key has a value of type ascii string. More...
 
 UNICODE
 The key has a value of type unicode string. More...
 
 BINARY
 The key has a value of type binary. More...
 
 LONGLIST
 The key has a value of type long list. More...
 
 STRINGLIST
 The key has a value of type ascii string list. More...
 
enum SAL_DLLPUBLIC_RTTI RegError
 specifies the possible error codes which can occur using the registry API. More...
 
 NO_ERROR
 no error. More...
 
 REGISTRY_NOT_OPEN
 registry is not open. More...
 
 REGISTRY_NOT_EXISTS
 registry does not exists. More...
 
 REGISTRY_READONLY
 registry is open with readonly access rights. More...
 
 DESTROY_REGISTRY_FAILED
 destroy a registry failed. There are may be any open keys. More...
 
 CANNOT_OPEN_FOR_READWRITE
 registry cannot be opened with readwrite access because the registry is already open with readwrite access anywhere. More...
 
 INVALID_REGISTRY
 registry is in an invalid state or the registry does not point to a valid registry data file. More...
 
 KEY_NOT_OPEN
 the key or key handle points to an invalid key or closed key. More...
 
 KEY_NOT_EXISTS
 the specified keyname points to a nonexisting key. More...
 
 CREATE_KEY_FAILED
 the key with the specified keyname cannot be created. More...
 
 DELETE_KEY_FAILED
 the specified key cannot be deleted. Maybe an open key handle exists to this key. More...
 
 INVALID_KEYNAME
 the keyname is invalid. More...
 
 INVALID_KEY
 the key is not in a valid state. More...
 
 VALUE_NOT_EXISTS
 the key has no value More...
 
 SET_VALUE_FAILED
 setting the specified value of a key failed. More...
 
 DELETE_VALUE_FAILED
 deleting of the key value failed. More...
 
 INVALID_VALUE
 the key has an invalid value or the value type is unknown. More...
 
 MERGE_ERROR
 merging a key, the value and all subkeys failed. More...
 
 MERGE_CONFLICT
 conflicts exists during the merge process of a key. More...
 

Macro Definition Documentation

#define REGISTRY_CALLTYPE   SAL_CALL

specify the calling convention for the registry API

Definition at line 135 of file regtype.h.

Typedef Documentation

typedef void* RegHandle

defines the type of a registry handle used in the C API.

Definition at line 27 of file regtype.h.

typedef void* RegKeyHandle

defines the type of a registry key handle used in the C API.

Definition at line 30 of file regtype.h.

typedef void* RegValue

defines the type of a registry key value handle used in the C API.

Definition at line 33 of file regtype.h.

Enumeration Type Documentation

enum RegAccessMode
strong

defines the open/access mode of the registry.

Two modes are valid: -READONLY allows readonly access -READWRITE allows read and write access

Enumerator
READONLY 
READWRITE 

This mode allows readonly access.

Definition at line 41 of file regtype.h.

Variable Documentation

BINARY
CANNOT_OPEN_FOR_READWRITE

registry cannot be opened with readwrite access because the registry is already open with readwrite access anywhere.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::initRegistry().

CREATE_KEY_FAILED

the key with the specified keyname cannot be created.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::createKey(), and ORegistry::loadAndSaveKeys().

DELETE_KEY_FAILED

the specified key cannot be deleted. Maybe an open key handle exists to this key.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::eraseKey().

DELETE_VALUE_FAILED

deleting of the key value failed.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::deleteSubkeysAndValues().

DESTROY_REGISTRY_FAILED

destroy a registry failed. There are may be any open keys.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::destroyRegistry().

INVALID_KEY
INVALID_KEYNAME

the keyname is invalid.

This error will return if the keyname is NULL but should not be NULL in the context of a called function.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::createKey(), ORegistry::deleteKey(), ORegistry::eraseKey(), ORegKey::getResolvedKeyName(), and ORegistry::openKey().

INVALID_REGISTRY

registry is in an invalid state or the registry does not point to a valid registry data file.

Definition at line 83 of file regtype.h.

Referenced by closeRegistry(), destroyRegistry(), dumpRegistry(), getName(), ORegistry::initRegistry(), mergeKey(), and openRootKey().

INVALID_VALUE
KEY_NOT_EXISTS

the specified keyname points to a nonexisting key.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::dumpKey(), and ORegistry::openKey().

KEY_NOT_OPEN

the key or key handle points to an invalid key or closed key.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::closeKey().

LONG

The key has a value of type long.

Definition at line 62 of file regtype.h.

Referenced by ORegistry::dumpValue(), ORegKey::getValue(), and ORegKey::setValue().

LONGLIST
MERGE_CONFLICT

conflicts exists during the merge process of a key.

This could happen if the value of a key already exists and the merge process will replace it.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::checkBlop(), ORegistry::loadAndSaveKeys(), ORegistry::loadAndSaveValue(), ORegistry::loadKey(), and mergeKey().

MERGE_ERROR

merging a key, the value and all subkeys failed.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::checkBlop(), ORegistry::loadAndSaveKeys(), ORegistry::loadAndSaveValue(), and ORegistry::loadKey().

NO_ERROR

no error.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::acquireKey(), ORegistry::checkBlop(), Registry::close(), RegistryKey::closeKey(), ORegistry::closeRegistry(), closeRegistry(), closeSubKeys(), ORegistry::createKey(), RegistryKey::createKey(), createRegistry(), ORegistry::deleteSubkeysAndValues(), Registry::destroy(), ORegistry::destroyRegistry(), destroyRegistry(), ORegistry::dumpKey(), ORegistry::dumpRegistry(), ORegistry::dumpValue(), ORegistry::eraseKey(), freeKeyNames(), freeValueList(), getKeyName(), ORegKey::getKeyNames(), RegistryKey::getKeyNames(), getLongListValue(), ORegKey::getLongListValue(), RegistryKey::getLongListValue(), getName(), ORegKey::getResolvedKeyName(), getResolvedKeyName(), getStringListValue(), ORegKey::getStringListValue(), RegistryKey::getStringListValue(), getUnicodeListValue(), ORegKey::getUnicodeListValue(), RegistryKey::getUnicodeListValue(), getValue(), ORegKey::getValue(), getValueInfo(), ORegKey::getValueInfo(), ORegistry::initRegistry(), ORegistry::loadAndSaveKeys(), ORegistry::loadAndSaveValue(), ORegistry::loadKey(), mergeKey(), ORegistry::mergeModuleValue(), ORegistry::openKey(), RegistryKey::openKey(), openRegistry(), openRootKey(), ORegKey::openSubKeys(), RegistryKey::openSubKeys(), reg_closeRegistry(), reg_openRegistry(), ORegistry::releaseKey(), setLongListValue(), ORegKey::setLongListValue(), setStringListValue(), ORegKey::setStringListValue(), setUnicodeListValue(), ORegKey::setUnicodeListValue(), setValue(), and ORegKey::setValue().

NOT_DEFINED

The key has no value or the value type is unknown.

Definition at line 62 of file regtype.h.

Referenced by ORegistry::dumpValue(), ORegKey::getValue(), getValueInfo(), ORegKey::getValueInfo(), and ORegKey::setValue().

enum SAL_DLLPUBLIC_RTTI RegError
strong
REGISTRY_NOT_EXISTS

registry does not exists.

Definition at line 83 of file regtype.h.

Referenced by ORegistry::closeRegistry(), ORegistry::destroyRegistry(), and ORegistry::initRegistry().

REGISTRY_NOT_OPEN

registry is not open.

Definition at line 83 of file regtype.h.

Referenced by closeRegistry(), dumpRegistry(), getName(), mergeKey(), openRootKey(), and reg_closeRegistry().

REGISTRY_READONLY
enum SAL_DLLPUBLIC_RTTI RegValueType
strong

defines the type of a key value.

A registry key can contain a value which has one of seven different types. Three simple types (long, ascii and unicode string) and a list type of these simple types. Furthermore a binary type which provides the possibility to define own data structures and store these types in the registry. The UNO core reflection data is stored as a binary blob in the type registry.

Definition at line 59 of file regtype.h.

Referenced by ORegistry::checkBlop(), ORegistry::dumpValue(), ORegKey::getLongListValue(), ORegKey::getStringListValue(), ORegKey::getUnicodeListValue(), ORegKey::getValue(), getValueInfo(), ORegKey::getValueInfo(), and ORegistry::loadAndSaveValue().

SET_VALUE_FAILED

setting the specified value of a key failed.

Definition at line 83 of file regtype.h.

Referenced by ORegKey::setLongListValue(), ORegKey::setStringListValue(), ORegKey::setUnicodeListValue(), and ORegKey::setValue().

STRING

The key has a value of type ascii string.

Definition at line 62 of file regtype.h.

Referenced by ORegistry::dumpValue(), ORegKey::getValue(), and ORegKey::setValue().

STRINGLIST

The key has a value of type ascii string list.

Definition at line 62 of file regtype.h.

Referenced by ORegistry::dumpValue(), freeValueList(), ORegKey::getStringListValue(), RegistryKey::getStringListValue(), ORegKey::getValue(), and ORegKey::setStringListValue().

UNICODE

The key has a value of type unicode string.

Definition at line 62 of file regtype.h.

Referenced by ORegistry::dumpValue(), ORegKey::getValue(), and ORegKey::setValue().

VALUE_NOT_EXISTS