registry/inc/regapi.hxx

   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
  27 /** This function opens the specified key.
  28
  29     @param  hKey identifies a currently open key. The key which will be opened by this function
  30                  is a subkey of the key identified by hKey
  31     @param  keyName points to a null terminated string specifying the name of a key.
  32     @param  phOpenKey points to a variable that receives the handle of the opened key.
  33                      The memory to store this variable will be allocated and will be freed by the function
  34                      reg_closeKey. If the function fails, phNewKey is NULL.
  35     @return REG_NO_ERROR if succeeds else an error code.
  36 */
  37 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openKey(RegKeyHandle hKey,
  38                                          rtl_uString* keyName,
  39                                          RegKeyHandle* phOpenKey);
  40
  41
  42 /** This function closes the specified key.
  43
  44     @param  hKey identifies a currently open key which will be closed by this function.
  45                  The memory of the variable specifying the key will be freed.
  46     @return REG_NO_ERROR if succeeds else an error code.
  47 */
  48 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeKey(RegKeyHandle hKey);
  49
  50
  51 /** This function opens the root key of a registry.
  52
  53     @param  hRegistry identifies a currently open registry whose rootKey will be returned.
  54     @param  phRootKey points to a handle of the open root key if the function succeeds otherwise NULL.
  55     @return REG_NO_ERROR if succeeds else an error code.
  56 */
  57 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRootKey(RegHandle hRegistry,
  58                                              RegKeyHandle* phRootKey);
  59
  60
  61 /** This function opens a registry with the specified name. in readonly mode.
  62
  63     @param  registryName points to a null terminated string specifying the name of the registry.
  64     @param  phRegistry points to a handle of the opened registry if the function succeeds otherwise NULL.
  65     @return REG_NO_ERROR if succeeds else an error code.
  66 */
  67 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRegistry(rtl_uString* registryName,
  68                                                RegHandle* phRegistry);
  69
  70
  71 /** This function closes a registry.
  72
  73     @param  hRegistry identifies a currently open registry which should be closed.
  74     @return REG_NO_ERROR if succeeds else an error code.
  75 */
  76 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeRegistry(RegHandle hRegistry);
  77
  78
  79 /** This function reports the complete registry information of a key and all of its subkeys.
  80
  81     All information which are available (keynames, value types, values, ...)
  82     will be printed to stdout for report issues only.
  83     @param  hKey identifies a currently open key which content will be reported.
  84     @return REG_NO_ERROR if succeeds else an error code.
  85 */
  86 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_dumpRegistry(RegKeyHandle hKey);
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */