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

namespace  o3tl
 

Macros

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

Typedefs

typedef void * RegHandle
 defines the type of a registry handle used in the C API. More...
 
typedef void * RegKeyHandle
 defines the type of a registry key handle used in the C API. More...
 
typedef void * RegValue
 defines the type of a registry key value handle used in the C API. More...
 

Enumerations

enum class  RegAccessMode {
  READONLY = 0x0001 ,
  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...
 

Macro Definition Documentation

◆ REGISTRY_CALLTYPE

#define REGISTRY_CALLTYPE   SAL_CALL

specify the calling convention for the registry API

Definition at line 129 of file regtype.h.

Typedef Documentation

◆ RegHandle

typedef void* RegHandle

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

Definition at line 26 of file regtype.h.

◆ RegKeyHandle

typedef void* RegKeyHandle

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

Definition at line 29 of file regtype.h.

◆ RegValue

typedef void* RegValue

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

Definition at line 32 of file regtype.h.

Enumeration Type Documentation

◆ RegAccessMode

enum class 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 40 of file regtype.h.

Variable Documentation

◆ BINARY

BINARY

The key has a value of type binary.

Definition at line 71 of file regtype.h.

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

◆ CANNOT_OPEN_FOR_READWRITE

CANNOT_OPEN_FOR_READWRITE

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

Definition at line 97 of file regtype.h.

Referenced by ORegistry::initRegistry().

◆ CREATE_KEY_FAILED

CREATE_KEY_FAILED

the key with the specified keyname cannot be created.

Definition at line 108 of file regtype.h.

Referenced by ORegistry::createKey().

◆ DELETE_KEY_FAILED

DELETE_KEY_FAILED

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

Definition at line 110 of file regtype.h.

Referenced by ORegistry::eraseKey().

◆ DELETE_VALUE_FAILED

DELETE_VALUE_FAILED

deleting of the key value failed.

Definition at line 123 of file regtype.h.

Referenced by ORegistry::deleteSubkeysAndValues().

◆ DESTROY_REGISTRY_FAILED

DESTROY_REGISTRY_FAILED

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

Definition at line 93 of file regtype.h.

Referenced by ORegistry::destroyRegistry().

◆ INVALID_KEY

INVALID_KEY

◆ INVALID_KEYNAME

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 114 of file regtype.h.

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

◆ INVALID_REGISTRY

INVALID_REGISTRY

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

Definition at line 101 of file regtype.h.

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

◆ KEY_NOT_EXISTS

KEY_NOT_EXISTS

the specified keyname points to a nonexisting key.

Definition at line 106 of file regtype.h.

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

◆ KEY_NOT_OPEN

KEY_NOT_OPEN

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

Definition at line 104 of file regtype.h.

Referenced by ORegistry::closeKey().

◆ LONG

LONG

The key has a value of type long.

Definition at line 65 of file regtype.h.

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

◆ LONGLIST

LONGLIST

The key has a value of type long list.

Definition at line 73 of file regtype.h.

Referenced by ORegistry::dumpValue(), freeValueList(), RegistryKey::getLongListValue(), ORegKey::getLongListValue(), and ORegKey::setLongListValue().

◆ NO_ERROR

NO_ERROR

◆ NOT_DEFINED

NOT_DEFINED

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

Definition at line 63 of file regtype.h.

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

◆ RegError

enum SAL_DLLPUBLIC_RTTI RegError
strong

◆ REGISTRY_NOT_EXISTS

REGISTRY_NOT_EXISTS

registry does not exists.

Definition at line 89 of file regtype.h.

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

◆ REGISTRY_NOT_OPEN

REGISTRY_NOT_OPEN

registry is not open.

Definition at line 87 of file regtype.h.

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

◆ REGISTRY_READONLY

REGISTRY_READONLY

◆ RegValueType

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 60 of file regtype.h.

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

◆ SET_VALUE_FAILED

SET_VALUE_FAILED

setting the specified value of a key failed.

Definition at line 121 of file regtype.h.

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

◆ STRING

STRING

The key has a value of type ascii string.

Definition at line 67 of file regtype.h.

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

◆ STRINGLIST

STRINGLIST

The key has a value of type ascii string list.

Definition at line 75 of file regtype.h.

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

◆ UNICODE

UNICODE

The key has a value of type unicode string.

Definition at line 69 of file regtype.h.

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

◆ VALUE_NOT_EXISTS

VALUE_NOT_EXISTS