<QtEnvironmentVariables>

函数文档

这些函数将环境变量varName 的值作为QString 返回。如果在环境中未找到变量varName ，且提供了defaultValue ，则返回defaultValue 。否则返回QString()。

Qt 的环境操作函数是线程安全的，但这要求不要直接调用 getenv 和 putenv 等等效的 C 库函数。

下表说明了如何在qgetenv()和qEnvironmentVariable()之间进行选择：

另请参阅 qputenv()、qgetenv()、qEnvironmentVariableIsSet()、qEnvironmentVariableIsEmpty() 和qEnvironmentVariableIntegerValue()。

[noexcept] int qEnvironmentVariableIntValue(const char *varName, bool *ok = nullptr)

返回环境变量varName 的数值。如果ok 不为空，则根据转换是否成功，将*ok 设置为true 或false 。

等同于

   int to_int = qgetenv(varName).toInt(ok, 0);

，但速度更快，且不会抛出异常。

另请参阅 qgetenv()、qEnvironmentVariable() 和qEnvironmentVariableIsSet()。

[noexcept, since 6.10] std::optional<qint64> qEnvironmentVariableIntegerValue(const char *varName)

返回环境变量varName 的数值。如果该变量未设置或无法解析为整数，则返回std::nullopt 。

与

   int to_int = qgetenv(varName).toInt(ok, 0);

，但速度快得多，且不会抛出异常。

如果零值在语义上等同于空变量或未设置的变量，应用程序可以使用

   auto value = qEnvironmentVariableIntegerValue(varName).value_or(0);

请注意，在此情况下，解析值失败也会返回零。

但如果零值可用于禁用某些功能，应用程序可以将返回的std::optional 与零进行比较，只有当该变量已设置且包含一个解析为零的数字时，该比较才会为真，如下所示：

   bool equals_zero = qEnvironmentVariableIntegerValue(varName) == 0;

该函数在 Qt 6.10 中引入。

另请参阅 qgetenv()、qEnvironmentVariable() 和qEnvironmentVariableIsSet()。

[noexcept] bool qEnvironmentVariableIsEmpty(const char *varName)

返回环境变量varName 是否为空。

等同于

   bool is_empty = qgetenv(varName).isEmpty();

，不同之处在于它可能快得多，且不会抛出异常。

另请参阅 qgetenv()、qEnvironmentVariable() 和qEnvironmentVariableIsSet()。

[noexcept] bool qEnvironmentVariableIsSet(const char *varName)

返回环境变量varName 是否已设置。

等同于

   bool is_not_null = !qgetenv(varName).isNull();

，但前者速度可能快得多，且不会抛出异常。

另请参阅 qgetenv()、qEnvironmentVariable()、qEnvironmentVariableIsEmpty() 以及qEnvironmentVariableIntegerValue()。

QByteArray qgetenv(const char *varName)

返回名称为varName 的环境变量的值，该值以QByteArray 的形式返回。如果环境中的确找不到该名称的变量，则该函数返回一个通过默认构造函数构造的QByteArray 。

Qt 的环境操作函数是线程安全的，但这要求不要直接调用 C 库中的等效函数（如 getenv 和 putenv）。

要将数据转换为QString ，请使用QString::fromLocal8Bit()。

注意：此函数是线程安全的。

另请参阅 qputenv()、qEnvironmentVariable()、qEnvironmentVariableIsSet()、qEnvironmentVariableIsEmpty() 以及qEnvironmentVariableIntegerValue()。

bool qputenv(const char *varName, QByteArrayView value)

该函数用于设置名为varName 的环境变量的value 。如果该变量不存在，则会创建该变量。如果无法设置该变量，则返回0。

在 Windows 系统上，若向 qputenv 传入空值，将删除该环境变量；而在 Unix 系统上，则会将其设置为空值。为确保完全可移植性，建议优先使用qunsetenv()。

另请参见 qgetenv() 和qEnvironmentVariable()。

bool qunsetenv(const char *varName)

该函数将变量varName 从环境中删除。

成功时返回true 。

另请参阅 qputenv()、qgetenv() 和qEnvironmentVariable()。