shell/inc/internal/registry.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: registry.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef REGISTRY_HXX_INCLUDED
  32 #define REGISTRY_HXX_INCLUDED
  33
  34 //-----------------------------
  35 // registry helper functions
  36 //-----------------------------
  37
  38 #if defined _MSC_VER
  39 #pragma warning(push, 1)
  40 #endif
  41 #include <objbase.h>
  42 #if defined _MSC_VER
  43 #pragma warning(pop)
  44 #endif
  45 #include <string>
  46
  47 /** Sets a value of the specified registry key, an empty ValueName sets the default
  48     value
  49     Returns true on success
  50 */
  51 bool SetRegistryKey(HKEY RootKey, const char* KeyName, const char* ValueName, const char* Value);
  52
  53 /** Deletes the specified registry key and all of its subkeys
  54     Returns true on success
  55 */
  56 bool DeleteRegistryKey(HKEY RootKey, const char* KeyName);
  57
  58 /** May be used to determine if the specified registry key has subkeys
  59     The function returns true on success else if an error occures false
  60 */
  61 bool HasSubkeysRegistryKey(HKEY RootKey, const char* KeyName, bool& bResult);
  62
  63 /** Converts a GUID to its string representation
  64 */
  65 std::string ClsidToString(const CLSID& clsid);
  66
  67 /** Get the content of a specific key.
  68 */
  69 bool QueryRegistryKey(HKEY RootKey, const char* KeyName, const char* ValueName, char *pszData, DWORD dwBufLen);
  70
  71
  72 #endif