summaryrefslogtreecommitdiff
path: root/registry/inc/registry/regtype.h
blob: c53b5134497222648293f0d5c69ae3f538f81a50 (plain)
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
183
184
185
186
187
188
189
/*************************************************************************
 *
 *  $RCSfile: regtype.h,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: jsc $ $Date: 2001-05-04 13:30:46 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef _REGISTRY_REGTYPE_H_
#define _REGISTRY_REGTYPE_H_

#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif

// 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.
#ifdef SAL_W32
#define LIBRARY_VERSION "2"
#else
#define LIBRARY_VERSION
#endif

typedef void*       RegHandle;

typedef void*       RegKeyHandle;

typedef void*       RegValue;

typedef sal_uInt16  RegAccessMode;

#define REG_READONLY        0x0001  // allow read accesses only
#define REG_READWRITE       0x0002  // allow read and write accesses

/// RegKeyType specify the type of the key, if it is a real key or a link
enum RegKeyType
{
    /// The key is a real key
    RG_KEYTYPE,
    /// The key is a link
    RG_LINKTYPE
};

/// RegValueType specify the type of the value of a key
enum RegValueType
{
    /// The key has no value
    RG_VALUETYPE_NOT_DEFINED,
    /// The key has a value of type long
    RG_VALUETYPE_LONG,
    /// The key has a value of type ascii
    RG_VALUETYPE_STRING,
    /// The key has a value of type unicode
    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 list
    RG_VALUETYPE_STRINGLIST,
    /// The key has a value of type unicode list
    RG_VALUETYPE_UNICODELIST
};

/// RegError specify the possible error codes
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 readonly
    REG_REGISTRY_READONLY,
    /// destroy registry failed. Ther are may be any open keys.
    REG_DESTROY_REGISTRY_FAILED,
    /** registry cannot open for readwrite because the registry is already
        open for readwrite anywhere.
    */
    REG_CANNOT_OPEN_FOR_READWRITE,
    /** registry is in a invalid state or the registry does not point to
        a valid registry data file
    */
    REG_INVALID_REGISTRY,

    /// The key is not open
    REG_KEY_NOT_OPEN,
    /// The key not exists
    REG_KEY_NOT_EXISTS,
    /// The key cannot created
    REG_CREATE_KEY_FAILED,
    /// The key cannot not deleted
    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 called function.
    */
    REG_INVALID_KEYNAME,
    /// The key is not in a valid state
    REG_INVALID_KEY,

    /// key has no value
    REG_VALUE_NOT_EXISTS,
    ///
    REG_SET_VALUE_FAILED,
    ///
    REG_DELETE_VALUE_FAILED,
    ///
    REG_INVALID_VALUE,

    ///
    REG_MERGE_ERROR,
    ///
    REG_MERGE_CONFLICT,

    ///
    REG_DETECT_RECURSION,
    ///
    REG_INVALID_LINK,
    ///
    REG_INVALID_LINKNAME,
    ///
    REG_INVALID_LINKTARGET,
    ///
    REG_LINKTARGET_NOT_EXIST,
    ///
    REG_BUFFERSIZE_TOSMALL
};


#define REGISTRY_CALLTYPE   SAL_CALL

#endif