Code/Engine/Foundation/System/EnvironmentVariableUtils.h - dev - redgpu/ezEngine

Code/Engine/Foundation/System/EnvironmentVariableUtils.h

40 строк2 KB

Jan Krassnigg

Even more migration to ezStringView (Tools, Plugins, Foundation) (#979)

08 июн 2023, 15:18

08 июн 2023, 15:18568268d

#pragma once

#include <Foundation/Basics.h>
#include <Foundation/Strings/String.h>

/// \brief This is a helper class to interact with environment variables.
class EZ_FOUNDATION_DLL ezEnvironmentVariableUtils
{
public:
  /// \brief Returns the current value of the request environment variable. If it isn't set szDefault will be returned.
  static ezString GetValueString(ezStringView sName, ezStringView sDefault = nullptr);

  /// \brief Sets the environment variable for the current execution environment (i.e. this process and child processes created after this call).
  static ezResult SetValueString(ezStringView sName, ezStringView sValue);

  /// \brief Returns the current value of the request environment variable. If it isn't set iDefault will be returned.
  static ezInt32 GetValueInt(ezStringView sName, ezInt32 iDefault = -1);

  /// \brief Sets the environment variable for the current execution environment.
  static ezResult SetValueInt(ezStringView sName, ezInt32 iValue);

  /// \brief Returns true if the environment variable with the given name is set, false otherwise.
  static bool IsVariableSet(ezStringView sName);

  /// \brief Removes an environment variable from the current execution context (i.e. this process and child processes created after this call).
  static ezResult UnsetVariable(ezStringView sName);

private:
  /// \brief [internal]
  static ezString GetValueStringImpl(ezStringView sName, ezStringView sDefault);

  /// \brief [internal]
  static ezResult SetValueStringImpl(ezStringView sName, ezStringView sValue);

  /// \brief [internal]
  static bool IsVariableSetImpl(ezStringView sName);

  /// \brief [internal]
  static ezResult UnsetVariableImpl(ezStringView sName);
};