QProcessEnvironment Class

成员函数文档

QProcessEnvironment::QProcessEnvironment()

创建一个新的 QProcessEnvironment 对象。该构造函数将创建一个空环境。如果在QProcess 上设置，将导致删除当前环境变量（Windows 上的 PATH 和 SystemRoot 除外）。

[noexcept, since 6.3] QProcessEnvironment::QProcessEnvironment(QProcessEnvironment::Initialization)

创建一个对象，在QProcess 上设置后，该对象将以继承自父进程的环境变量的方式执行。

如果需要父进程环境的修改版本，可从systemEnvironment() 的返回值开始修改（但要注意，父进程环境创建后的更改不会反映在修改后的环境中）。

此函数在 Qt 6.3 中引入。

另请参阅 inheritsFromParent() 和systemEnvironment()。

QProcessEnvironment::QProcessEnvironment(const QProcessEnvironment &other)

创建一个 QProcessEnvironment 对象，它是other 的副本。

[noexcept] QProcessEnvironment::~QProcessEnvironment()

释放与QProcessEnvironment 对象相关的资源。

void QProcessEnvironment::clear()

删除QProcessEnvironment 对象中的所有 key=value 对，使其为空。

如果环境是使用QProcessEnvironment::InheritFromParent 构建的，则保持不变。

另请参阅 isEmpty() 和systemEnvironment()。

bool QProcessEnvironment::contains(const QString &name) const

如果在QProcessEnvironment 对象中找到名称为name 的环境变量，则返回true 。

另请参阅 insert() 和value()。

[since 6.3] bool QProcessEnvironment::inheritsFromParent() const

如果此QProcessEnvironment 是使用QProcessEnvironment::InheritFromParent 构建的，则返回true 。

此函数在 Qt 6.3 中引入。

另请参阅 isEmpty() 。

void QProcessEnvironment::insert(const QString &name, const QString &value)

将名称为name 、内容为value 的环境变量插入QProcessEnvironment 对象。如果该变量已经存在，它将被新值取代。

在大多数系统中，插入一个没有内容的变量对应用程序的影响与未设置变量的影响相同。不过，为了保证不出现不兼容问题，删除变量时请使用remove() 函数。

另请参见 contains()、remove() 和value()。

void QProcessEnvironment::insert(const QProcessEnvironment &e)

这是一个重载函数。

将e 中的内容插入QProcessEnvironment 对象。该对象中同时存在于e 中的变量将被覆盖。

bool QProcessEnvironment::isEmpty() const

如果QProcessEnvironment 对象为空，即没有键=值对，则返回true 。

对于使用QProcessEnvironment::InheritFromParent 构建的对象，此方法也返回true 。

另请参阅 clear()、systemEnvironment()、insert() 和inheritsFromParent()。

QStringList QProcessEnvironment::keys() const

返回包含QProcessEnvironment 对象中所有变量名的列表。

对于使用QProcessEnvironment::InheritFromParent 构建的对象，返回的列表为空。

void QProcessEnvironment::remove(const QString &name)

从QProcessEnvironment 对象中删除name 标识的环境变量。如果该变量之前不存在，则不会发生任何操作。

另请参阅 contains()、insert() 和value()。

[noexcept] void QProcessEnvironment::swap(QProcessEnvironment &other)

将此进程环境实例与other 互换。这一操作非常快速，从未出现过故障。

[static] QProcessEnvironment QProcessEnvironment::systemEnvironment()

systemEnvironment 函数返回调用进程的环境。

它以QProcessEnvironment 的形式返回。该函数不缓存系统环境。因此，如果调用了低级 C 库函数（如setenv 或putenv ），则有可能获得环境的更新版本。

不过，需要注意的是，重复调用该函数将重新创建QProcessEnvironment 对象，这是一个非繁琐的操作。

另请参见 QProcess::systemEnvironment()。

QStringList QProcessEnvironment::toStringList() const

将QProcessEnvironment 对象转换为字符串列表，每个环境变量设置一个字符串。环境变量的名称和值之间用等号分隔（'='）。

此函数返回的QStringList 内容适合用于演示。不建议与 QProcess::setEnvironment 函数一起使用，因为在 Unix 环境下可能会出现编码问题，性能也会变差。

另请参阅 systemEnvironment()、QProcess::systemEnvironment() 和QProcess::setProcessEnvironment()。

QString QProcessEnvironment::value(const QString &name, const QString &defaultValue = QString()) const

在QProcessEnvironment 对象中搜索由name 标识的变量，并返回其值。如果在该对象中找不到该变量，则返回defaultValue 。

另请参见 contains()、insert() 和remove()。

QProcessEnvironment &QProcessEnvironment::operator=(const QProcessEnvironment &other)

将other QProcessEnvironment 对象的内容复制到此对象中。