LibreOffice Module registry (master)  1
regtype.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_REGISTRY_REGTYPE_H
21 #define INCLUDED_REGISTRY_REGTYPE_H
22 
23 #include <sal/types.h>
24 #include <o3tl/typed_flags_set.hxx>
25 
27 typedef void* RegHandle;
28 
30 typedef void* RegKeyHandle;
31 
33 typedef void* RegValue;
34 
41 enum class RegAccessMode
42 {
43  READONLY = 0x0001,
44  READWRITE = 0x0002
45 };
46 namespace o3tl
47 {
48 template <> struct typed_flags<RegAccessMode> : is_typed_flags<RegAccessMode, 0x03>
49 {
50 };
51 }
52 
61 enum class SAL_DLLPUBLIC_RTTI RegValueType
62 {
66  LONG,
68  STRING,
70  UNICODE,
72  BINARY,
74  LONGLIST,
76  STRINGLIST,
78  UNICODELIST
79 };
80 
82 enum class SAL_DLLPUBLIC_RTTI RegError
83 {
86 
103 
105  KEY_NOT_OPEN,
117  INVALID_KEY,
118 
127 
129  MERGE_ERROR,
134 };
135 
137 #define REGISTRY_CALLTYPE SAL_CALL
138 
139 #endif
140 
141 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
DESTROY_REGISTRY_FAILED
destroy a registry failed. There are may be any open keys.
Definition: regtype.h:85
STRINGLIST
The key has a value of type ascii string list.
Definition: regtype.h:64
STRING
The key has a value of type ascii string.
Definition: regtype.h:64
NO_ERROR
no error.
Definition: regtype.h:85
RegAccessMode
defines the open/access mode of the registry.
Definition: regtype.h:41
UNICODE
The key has a value of type unicode string.
Definition: regtype.h:64
LONG
The key has a value of type long.
Definition: regtype.h:64
LONGLIST
The key has a value of type long list.
Definition: regtype.h:64
MERGE_CONFLICT
conflicts exists during the merge process of a key.
Definition: regtype.h:85
MERGE_ERROR
merging a key, the value and all subkeys failed.
Definition: regtype.h:85
NOT_DEFINED
The key has no value or the value type is unknown.
Definition: regtype.h:64
REGISTRY_NOT_OPEN
registry is not open.
Definition: regtype.h:85
CREATE_KEY_FAILED
the key with the specified keyname cannot be created.
Definition: regtype.h:85
void * RegHandle
defines the type of a registry handle used in the C API.
Definition: regtype.h:27
enum SAL_DLLPUBLIC_RTTI RegError
specifies the possible error codes which can occur using the registry API.
Definition: regtype.h:82
BINARY
The key has a value of type binary.
Definition: regtype.h:64
SET_VALUE_FAILED
setting the specified value of a key failed.
Definition: regtype.h:85
enum SAL_DLLPUBLIC_RTTI RegValueType
defines the type of a key value.
Definition: regtype.h:61
REGISTRY_NOT_EXISTS
registry does not exists.
Definition: regtype.h:85
VALUE_NOT_EXISTS
the key has no value
Definition: regtype.h:85
DELETE_VALUE_FAILED
deleting of the key value failed.
Definition: regtype.h:85
INVALID_KEYNAME
the keyname is invalid.
Definition: regtype.h:85
KEY_NOT_EXISTS
the specified keyname points to a nonexisting key.
Definition: regtype.h:85
KEY_NOT_OPEN
the key or key handle points to an invalid key or closed key.
Definition: regtype.h:85
INVALID_VALUE
the key has an invalid value or the value type is unknown.
Definition: regtype.h:85
INVALID_KEY
the key is not in a valid state.
Definition: regtype.h:85
DELETE_KEY_FAILED
the specified key cannot be deleted. Maybe an open key handle exists to this key. ...
Definition: regtype.h:85
void * RegKeyHandle
defines the type of a registry key handle used in the C API.
Definition: regtype.h:30
REGISTRY_READONLY
registry is open with readonly access rights.
Definition: regtype.h:85
void * RegValue
defines the type of a registry key value handle used in the C API.
Definition: regtype.h:33
CANNOT_OPEN_FOR_READWRITE
registry cannot be opened with readwrite access because the registry is already open with readwrite a...
Definition: regtype.h:85
INVALID_REGISTRY
registry is in an invalid state or the registry does not point to a valid registry data file...
Definition: regtype.h:85