environment类 参考

环境变量管理类 更多...

#include <environment.hpp>

静态 Public 成员函数
static NEFORCE_NODISCARD string	get (const string &name)
	获取环境变量值
static bool	set (const string &name, const string &value, bool overwrite=true)
	设置环境变量
static bool	unset (const string &name)
	删除环境变量
static NEFORCE_NODISCARD bool	exists (const string &name)
	检查环境变量是否存在
static NEFORCE_NODISCARD unordered_map< string, string >	all_envs ()
	获取所有环境变量
static NEFORCE_NODISCARD vector< string >	path_list ()
	获取PATH环境变量的路径列表
static bool	add_to_path (const string &path, int position=1)
	向PATH环境变量添加路径
static NEFORCE_NODISCARD string	current_directory ()
	获取当前工作目录
static NEFORCE_NODISCARD string	current_user ()
	获取当前用户名
static NEFORCE_NODISCARD string	temp_directory ()
	获取临时目录路径
static NEFORCE_NODISCARD string	home_directory ()
	获取用户主目录路径

静态 Public 属性
static constexpr char	delimiter
	路径分隔符

详细描述

环境变量管理类

提供静态方法用于访问和修改环境变量，所有操作都是线程安全的。

在文件 environment.hpp 第 28 行定义.

成员函数说明

add_to_path()

bool environment::add_to_path ( const string & path, int position = 1 )

static

向PATH环境变量添加路径

参数

path	要添加的路径
position	添加位置（0：开头，其他：末尾）

返回

是否添加成功

all_envs()

NEFORCE_NODISCARD unordered_map< string, string > environment::all_envs ( )

static

获取所有环境变量

返回

环境变量名到值的映射

current_directory()

NEFORCE_NODISCARD string environment::current_directory ( )

static

获取当前工作目录

返回

当前目录路径

异常

system_exception

获取失败时抛出

current_user()

NEFORCE_NODISCARD string environment::current_user ( )

static

获取当前用户名

返回

用户名

exists()

NEFORCE_NODISCARD bool environment::exists ( const string & name )

static

检查环境变量是否存在

参数

name

环境变量名

返回

是否存在

引用了 name().

get()

NEFORCE_NODISCARD string environment::get ( const string & name )

static

获取环境变量值

参数

name

环境变量名

返回

环境变量值，不存在返回空字符串

引用了 name().

home_directory()

NEFORCE_NODISCARD string environment::home_directory ( )

static

获取用户主目录路径

返回

主目录路径

按照优先级尝试：

• Windows: USERPROFILE, HOMEDRIVE+HOMEPATH
• Linux: HOME

path_list()

NEFORCE_NODISCARD vector< string > environment::path_list ( )

static

获取PATH环境变量的路径列表

返回

路径列表

set()

bool environment::set ( const string & name, const string & value, bool overwrite = true )

static

设置环境变量

参数

name	环境变量名
value	环境变量值
overwrite	是否覆盖已有值

返回

是否设置成功

引用了 name().

temp_directory()

NEFORCE_NODISCARD string environment::temp_directory ( )

static

获取临时目录路径

返回

临时目录路径

按照优先级尝试：

• Windows: TMP, TEMP, USERPROFILE
• Linux: TMPDIR, TEMP, TMP, /tmp

unset()

bool environment::unset ( const string & name )

static

删除环境变量

参数

name

环境变量名

返回

是否删除成功

引用了 name().

---

该类的文档由以下文件生成:

• environment.hpp