EnvironmentVariables.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : EnvironmentVariables
 * Package    : Zeus.ZeusBase.System
 * Author     : Martin Abbuehl
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef EnvironmentVariablesH
#define EnvironmentVariablesH

#include <zeusbase/Config/PlatformDefines.hpp>
#include <zeusbase/System/String.h>


#ifdef ENABLE_WIN32_BINDING // This check needs that <zeusbase/Config/PlatformDefines.hpp> is included above.
  #include <windows.h> // For HKEY.
#endif



BEGIN_NAMESPACE_Zeus


/**************************************************************************/
/**************************************************************************/
zeusbase_class TEnvironmentVariables
{
  public:
    enum ESettingMethod
    {
      etCurrentProcess,
      etPersistentlyCurrentUser,
      etPersistentlyLocalMachine
    };

    static bool deleteEnvironmentVariable(const IString& strName, ESettingMethod eMethod);

    static TString getEnvironmentVariable(const IString& strName);

    static bool setEnvironmentVariable(const IString& strName, const IString& strValue,
                                       ESettingMethod eMethod);

  private:
    inline TEnvironmentVariables() { }
    virtual inline ~TEnvironmentVariables() { }

    #ifdef ENABLE_WIN32_BINDING

      static bool writeRegistryValue(HKEY hRootKey, const TString& strRegistryPath,
                                     const TString& strValueName, const TString& strValue);
    #endif
};


END_NAMESPACE_Zeus

#endif