LibreOffice Module registry (master)  1
regapi.hxx
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 #ifndef INCLUDED_REGISTRY_INC_REGAPI_HXX
21 #define INCLUDED_REGISTRY_INC_REGAPI_HXX
22 
23 #include <rtl/ustring.h>
24 #include <registry/regtype.h>
25 #include <registry/regdllapi.h>
26 
38  rtl_uString* keyName,
39  RegKeyHandle* phOpenKey);
40 
41 
49 
50 
58  RegKeyHandle* phRootKey);
59 
60 
68  RegHandle* phRegistry);
69 
70 
77 
78 
87 
88 #endif
89 
90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeRegistry(RegHandle hRegistry)
This function closes a registry.
Definition: registry.cxx:368
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeKey(RegKeyHandle hKey)
This function closes the specified key.
Definition: regkey.cxx:685
#define REG_DLLPUBLIC
Definition: regdllapi.h:28
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_dumpRegistry(RegKeyHandle hKey)
This function reports the complete registry information of a key and all of its subkeys.
Definition: registry.cxx:384
void * RegHandle
defines the type of a registry handle used in the C API.
Definition: regtype.h:27
enum SAL_DLLPUBLIC_RTTI RegError
specifies the possible error codes which can occur using the registry API.
Definition: regtype.h:80
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRegistry(rtl_uString *registryName, RegHandle *phRegistry)
This function opens a registry with the specified name.
Definition: registry.cxx:347
void * RegKeyHandle
defines the type of a registry key handle used in the C API.
Definition: regtype.h:30
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRootKey(RegHandle hRegistry, RegKeyHandle *phRootKey)
This function opens the root key of a registry.
Definition: registry.cxx:338
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openKey(RegKeyHandle hKey, rtl_uString *keyName, RegKeyHandle *phOpenKey)
This function opens the specified key.
Definition: regkey.cxx:672
#define REGISTRY_CALLTYPE
specify the calling convention for the registry API
Definition: regtype.h:135