env_vars.h File Reference

Functions related to environment variables, including help functions. More...

#include <wx/string.h>
#include <vector>
#include <optional>

Go to the source code of this file.

Namespaces
namespace	ENV_VAR

Typedefs
using	ENV_VAR::ENV_VAR_LIST = std::vector< wxString >

Functions
bool	ENV_VAR::IsEnvVarImmutable (const wxString &aEnvVar)
	Determine if an environment variable is "predefined", i.e. More...
const ENV_VAR_LIST &	ENV_VAR::GetPredefinedEnvVars ()
	Get the list of pre-defined environment variables. More...
wxString	ENV_VAR::LookUpEnvVarHelp (const wxString &aEnvVar)
	Look up long-form help text for a given environment variable. More...
template<typename VAL_TYPE >
std::optional< VAL_TYPE >	ENV_VAR::GetEnvVar (const wxString &aEnvVarName)
	Get an environment variable as a specific type, if set correctly. More...
template<>
std::optional< wxString >	ENV_VAR::GetEnvVar (const wxString &aEnvVarName)
	Get a string environment variable, if it is set. More...
template<>
std::optional< double >	ENV_VAR::GetEnvVar (const wxString &aEnvVarName)
	Get a double from an environment variable, if set. More...

Detailed Description

Functions related to environment variables, including help functions.

Definition in file env_vars.h.