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#pragma once
21
22#include <sal/types.h>
24
26typedef void* RegHandle;
27
29typedef void* RegKeyHandle;
30
32typedef void* RegValue;
33
40enum class RegAccessMode
41{
42 READONLY = 0x0001,
43 READWRITE = 0x0002
44};
45namespace o3tl
46{
47template <> struct typed_flags<RegAccessMode> : is_typed_flags<RegAccessMode, 0x03>
48{
49};
50}
51
60enum class SAL_DLLPUBLIC_RTTI RegValueType
61{
77 UNICODELIST
78};
79
81enum class SAL_DLLPUBLIC_RTTI RegError
82{
85
102
117
125 INVALID_VALUE
126};
127
129#define REGISTRY_CALLTYPE SAL_CALL
130
131/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
const bool READONLY
STRINGLIST
The key has a value of type ascii string list.
Definition: regtype.h:75
DESTROY_REGISTRY_FAILED
destroy a registry failed. There are may be any open keys.
Definition: regtype.h:93
void * RegHandle
defines the type of a registry handle used in the C API.
Definition: regtype.h:26
INVALID_REGISTRY
registry is in an invalid state or the registry does not point to a valid registry data file.
Definition: regtype.h:101
VALUE_NOT_EXISTS
the key has no value
Definition: regtype.h:119
void * RegKeyHandle
defines the type of a registry key handle used in the C API.
Definition: regtype.h:29
KEY_NOT_OPEN
the key or key handle points to an invalid key or closed key.
Definition: regtype.h:104
REGISTRY_NOT_OPEN
registry is not open.
Definition: regtype.h:87
UNICODE
The key has a value of type unicode string.
Definition: regtype.h:69
INVALID_KEY
the key is not in a valid state.
Definition: regtype.h:116
RegAccessMode
defines the open/access mode of the registry.
Definition: regtype.h:41
REGISTRY_READONLY
registry is open with readonly access rights.
Definition: regtype.h:91
REGISTRY_NOT_EXISTS
registry does not exists.
Definition: regtype.h:89
NOT_DEFINED
The key has no value or the value type is unknown.
Definition: regtype.h:63
SET_VALUE_FAILED
setting the specified value of a key failed.
Definition: regtype.h:121
CANNOT_OPEN_FOR_READWRITE
registry cannot be opened with readwrite access because the registry is already open with readwrite a...
Definition: regtype.h:97
INVALID_KEYNAME
the keyname is invalid.
Definition: regtype.h:114
DELETE_KEY_FAILED
the specified key cannot be deleted. Maybe an open key handle exists to this key.
Definition: regtype.h:110
enum SAL_DLLPUBLIC_RTTI RegValueType
defines the type of a key value.
Definition: regtype.h:61
void * RegValue
defines the type of a registry key value handle used in the C API.
Definition: regtype.h:32
CREATE_KEY_FAILED
the key with the specified keyname cannot be created.
Definition: regtype.h:108
DELETE_VALUE_FAILED
deleting of the key value failed.
Definition: regtype.h:123
LONGLIST
The key has a value of type long list.
Definition: regtype.h:73
KEY_NOT_EXISTS
the specified keyname points to a nonexisting key.
Definition: regtype.h:106
BINARY
The key has a value of type binary.
Definition: regtype.h:71
LONG
The key has a value of type long.
Definition: regtype.h:65
STRING
The key has a value of type ascii string.
Definition: regtype.h:67
NO_ERROR
no error.
Definition: regtype.h:84
enum SAL_DLLPUBLIC_RTTI RegError
specifies the possible error codes which can occur using the registry API.
Definition: regtype.h:82