shell/inc/registry.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_SHELL_INC_INTERNAL_REGISTRY_HXX
  21 #define INCLUDED_SHELL_INC_INTERNAL_REGISTRY_HXX
  22
  23
  24 // registry helper functions
  25
  26
  27 #include <objbase.h>
  28 #include <string>
  29 #include "filepath.hxx"
  30
  31 /** Sets a value of the specified registry key, an empty ValueName sets the default
  32     value
  33     Returns true on success
  34 */
  35 bool SetRegistryKey(HKEY RootKey, const Filepath_char_t* KeyName, const Filepath_char_t* ValueName, const Filepath_char_t* Value);
  36
  37 /** Deletes the specified registry key and all of its subkeys
  38     Returns true on success
  39 */
  40 bool DeleteRegistryKey(HKEY RootKey, const Filepath_char_t* KeyName);
  41
  42 /** May be used to determine if the specified registry key has subkeys
  43     The function returns true on success else if an error occurs false
  44 */
  45 bool HasSubkeysRegistryKey(HKEY RootKey, const Filepath_char_t* KeyName, bool& bResult);
  46
  47 /** Converts a GUID to its string representation
  48 */
  49 Filepath_t ClsidToString(const CLSID& clsid);
  50
  51 /** Get the content of a specific key.
  52 */
  53 bool QueryRegistryKey(HKEY RootKey, const Filepath_char_t* KeyName, const Filepath_char_t* ValueName, Filepath_char_t *pszData, DWORD dwBufLen);
  54
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */