Glib::Environ Class Reference

A convenience class for manipulating a copy of the environment variables. More...

#include <glibmm/environ.h>

Public Member Functions
	Environ ()
	Constructs a list of environment variables for the current process. More...
	Environ (const std::vector< std::string > & env_vec)
	Constructs a Glib::Environ instance from a vector. More...
std::optional< std::string >	get (StdStringView variable) const
	Gets the value of the environment variable variable. More...
std::optional< std::string >	operator[] (StdStringView variable) const
	Same as get(). More...
void	set (StdStringView variable, StdStringView value, bool overwrite=true)
	Sets the environment variable variable in the provided list to value. More...
void	unset (StdStringView variable)
	Removes the environment variable variable from the provided list. More...
std::vector< std::string >	to_vector () const
	Get a vector with the environment variables. More...

Detailed Description

A convenience class for manipulating a copy of the environment variables.

Useful for generating the envp parameter in calls to Glib::spawn_async_with_pipes(), Glib::spawn_async() and Glib::spawn_sync().

If you want to change the environment itself (i.e. not a copy of it), see Glib::getenv(), Glib::setenv() and Glib::unsetenv().

Since glibmm 2.70:

Constructor & Destructor Documentation

Environ() [1/2]

Glib::Environ::Environ

(

)

Constructs a list of environment variables for the current process.

Each item in the list is of the form 'NAME=VALUE'.

Environ() [2/2]

Glib::Environ::Environ ( const std::vector< std::string > &  env_vec )

explicit

Constructs a Glib::Environ instance from a vector.

Parameters

env_vec

A vector with the environment variables. Each element in the vector must be of the form 'NAME=VALUE'.

Member Function Documentation

get()

std::optional< std::string > Glib::Environ::get

(

StdStringView

variable

)

const

Gets the value of the environment variable variable.

Parameters

variable

The environment variable to get, must not contain '='.

Returns

The value of the environment variable, or an empty std::optional if the environment variable is not set in this Environ.

operator[]()

std::optional< std::string > Glib::Environ::operator[] ( StdStringView  variable ) const

inline

Same as get().

set()

void Glib::Environ::set	(	StdStringView	variable,
		StdStringView	value,
		bool	overwrite = true
	)

Sets the environment variable variable in the provided list to value.

Parameters

variable	The environment variable to set, must not contain '='.
value	The value to set the variable to.
overwrite	Whether to change the variable if it already exists.

to_vector()

std::vector< std::string > Glib::Environ::to_vector

(

)

const

Get a vector with the environment variables.

Returns

A vector with the environment variables. Each element in the vector is of the form 'NAME=VALUE'.

unset()

void Glib::Environ::unset

(

StdStringView

variable

)

Removes the environment variable variable from the provided list.

Parameters

variable

The environment variable to remove, must not contain '='.