1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _REGISTRY_REGTYPE_H_
#define _REGISTRY_REGTYPE_H_
#include <sal/types.h>
#include <sal/udkversion.h>
// version number of the library. This number is used for the load on call
// mechanism and must be modifed when the library will be upgraded to a new version.
#define LIBRARY_VERSION SAL_UDK_MAJOR
/// defines the type of a registry handle used in the C API.
typedef void* RegHandle;
/// defines the type of a registry key handle used in the C API.
typedef void* RegKeyHandle;
/// defines the type of a registry key value handle used in the C API.
typedef void* RegValue;
/** defines the open/access mode of the registry.
Two modes are valid:
-REG_READONLY allows readonly access
-REG_READWRITE allows read and write access
*/
typedef sal_uInt16 RegAccessMode;
/// Flag to specify the open mode of a registry. This mode allows readonly access.
#define REG_READONLY 0x0001
/// Flag to specify the open mode of a registry. This mode allows read and write access.
#define REG_READWRITE 0x0002
/** defines the type of a registry key.
The registry differs between normal keys which can contain subkeys or
a value and link keys which navigate over the linktarget to an existing
other key (which are no longer supported).
*/
enum RegKeyType
{
/// represents a real key
RG_KEYTYPE,
/// represents a link (which is no longer supported)
RG_LINKTYPE
};
/** 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 possibilty
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.
*/
enum RegValueType
{
/// The key has no value or the value type is unknown.
RG_VALUETYPE_NOT_DEFINED,
/// The key has a value of type long
RG_VALUETYPE_LONG,
/// The key has a value of type ascii string
RG_VALUETYPE_STRING,
/// The key has a value of type unicode string
RG_VALUETYPE_UNICODE,
/// The key has a value of type binary
RG_VALUETYPE_BINARY,
/// The key has a value of type long list
RG_VALUETYPE_LONGLIST,
/// The key has a value of type ascii string list
RG_VALUETYPE_STRINGLIST,
/// The key has a value of type unicode string list
RG_VALUETYPE_UNICODELIST
};
/// specifies the possible error codes which can occur using the registry API.
enum RegError
{
/// no error.
REG_NO_ERROR,
/// internal registry error.
REG_INTERNAL_ERROR,
/// registry is not open.
REG_REGISTRY_NOT_OPEN,
/// registry does not exists.
REG_REGISTRY_NOT_EXISTS,
/// registry is open with readonly access rights.
REG_REGISTRY_READONLY,
/// destroy a registry failed. There are may be any open keys.
REG_DESTROY_REGISTRY_FAILED,
/** registry cannot be opened with readwrite access because the registry is already
open with readwrite access anywhere.
*/
REG_CANNOT_OPEN_FOR_READWRITE,
/** registry is in an invalid state or the registry does not point to
a valid registry data file.
*/
REG_INVALID_REGISTRY,
/// the key or key handle points to an invalid key or closed key.
REG_KEY_NOT_OPEN,
/// the specified keyname points to a nonexisting key.
REG_KEY_NOT_EXISTS,
/// the key with the specified keyname cannot be created.
REG_CREATE_KEY_FAILED,
/// the specified key cannot be deleted. Maybe an open key handle exists to this key.
REG_DELETE_KEY_FAILED,
/** 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.
*/
REG_INVALID_KEYNAME,
/// the key is not in a valid state.
REG_INVALID_KEY,
/// the key has no value
REG_VALUE_NOT_EXISTS,
/// setting the specified value of a key failed.
REG_SET_VALUE_FAILED,
/// deleting of the key value failed.
REG_DELETE_VALUE_FAILED,
/// the key has a invalid value or the value type is unknown.
REG_INVALID_VALUE,
/// merging a key, the value and all subkeys failed.
REG_MERGE_ERROR,
/** 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.
*/
REG_MERGE_CONFLICT,
/** a recursion was detected resolving different link targets (no longer
used).
*/
REG_DETECT_RECURSION,
/** the link is invalid and can not be resolved (now used by all
link-related operations, as links are no longer supported).
*/
REG_INVALID_LINK,
/// the specified linkname is not valid (no longer used).
REG_INVALID_LINKNAME,
/// the linknane is not valid (no longer used).
REG_INVALID_LINKTARGET,
/// the link target points to a nonexisting key (no longer used).
REG_LINKTARGET_NOT_EXIST,
/// the reserved buffer for the resolved keyname is to small.
REG_BUFFERSIZE_TOSMALL
};
/// specify the calling convention for the registry API
#define REGISTRY_CALLTYPE SAL_CALL
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
