diff options
Diffstat (limited to 'include/registry/regtype.h')
| -rw-r--r-- | include/registry/regtype.h | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/include/registry/regtype.h b/include/registry/regtype.h new file mode 100644 index 000000000000..86ddb299fb37 --- /dev/null +++ b/include/registry/regtype.h @@ -0,0 +1,168 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef _REGISTRY_REGTYPE_H_ +#define _REGISTRY_REGTYPE_H_ + +#include <sal/types.h> + +/// 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: */ |