From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- udkapi/com/sun/star/registry/DefaultRegistry.idl | 137 +++++++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 udkapi/com/sun/star/registry/DefaultRegistry.idl (limited to 'udkapi/com/sun/star/registry/DefaultRegistry.idl') diff --git a/udkapi/com/sun/star/registry/DefaultRegistry.idl b/udkapi/com/sun/star/registry/DefaultRegistry.idl new file mode 100644 index 000000000..2e4bbad1d --- /dev/null +++ b/udkapi/com/sun/star/registry/DefaultRegistry.idl @@ -0,0 +1,137 @@ +/* -*- 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 __com_sun_star_registry_DefaultRegistry_idl__ +#define __com_sun_star_registry_DefaultRegistry_idl__ + +#include + + + + module com { module sun { module star { module registry { + +/** implicitly supports a local registry and a read-only + system registry for global information. + In the context of this service, + the functions open, close, and destroy + from XSimpleRegistry are not supported and throw an exception + if they are used. + + Functions of XSimpleRegistry: +
+
getURL +
+
returns the name of the local registry. +
+
isValid +
+
checks if the local registry is valid. If the interface is not `NULL` + the local registry should always be valid. +
+
isReadOnly
+
checks if the local registry has write protection. +
+
mergeKey +
+
merges all information from the specified registry in the local registry. +
+
getRootKey +
+
returns a virtual rootkey of both registries. +
+
+ + Functions of XRegistryKey: +
+
openKey +
+
returns a virtual key which is specified in the local or the system + registry. +
+
deleteKey +
+
deletes the key only if it is present in the local registry. +
+
setLongValue, setAsciiValue, setStringValue, setBinaryValue +
+
sets the value at the specified key in the local registry. +
+
getLongValue, getAsciiValue, getStringValue, getBinaryValue +
+
returns the value at the specified key in the local registry, or if + the value is not present in the local registry, it will return the value of the + system registry. +
+
openKeys +
+
returns a sequence of all subkeys in both registries. +
+
getKeyNames +
+
returns a sequence with the names of all subkeys in both registries. +
+
+ Note: all write functions only work on the local registry. +
+
+ + How to find the registries: +
+
search for the system registry: +
+
The system registry will always be searched in the same directory as the + executable. The name of the system registry is "applicat.rdb". If the system + registry was not found, then the environment variable STAR_REGISTRY will be checked. + If this variable was set, it must contain a full path to a valid system registry. +
+
Search for the user registry using the following rules: +
+
+
    +
  1. 1. (for further use) search in sversion.ini (.sversionrc) for an entry + REGISTRY_VERSION_STRING (example: UserRegistry 5.0/505=test.rdb) in the section + [Registry]. If found, then take this value instead of "user.rdb" as "REGISTRY NAME". +
    2. +
  2. 2. Search in the config directory of the user for a file "REGISTRY NAME". If + found, return the full path and name of the file. If not found, retry this + step with a dot before "REGISTRY NAME". +
    3. +
  3. 3. If not found, a new user registry with name user.rdb will be created in the user + config directory. +
    4. +
+
+
+

Guarantees:

+ +
    +
  • -thread safe
    • +
+ */ +published service DefaultRegistry +{ + interface com::sun::star::registry::XSimpleRegistry; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3