<QtEnvironmentVariables>

Documentation des fonctions

Ces fonctions renvoient la valeur de la variable d'environnement « varName » sous la forme d'un objet « QString ». Si aucune variable « varName » n'est trouvée dans l'environnement et que « defaultValue » est fourni, « defaultValue » est renvoyé. Dans le cas contraire, « QString() » est renvoyé.

Les fonctions de manipulation de l’environnement Qt sont sûres pour les threads, mais cela nécessite que les fonctions équivalentes de la bibliothèque C, telles que getenv et putenv, ne soient pas appelées directement.

Le tableau suivant décrit comment choisir entre ` qgetenv()` et ` qEnvironmentVariable()` :

Voir également : qputenv(), qgetenv(), qEnvironmentVariableIsSet(), qEnvironmentVariableIsEmpty() et qEnvironmentVariableIntegerValue().

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

Renvoie la valeur numérique de la variable d'environnement varName. Si ok n'est pas nul, définit *ok sur true ou false selon que la conversion a réussi ou non.

Équivalent à

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

sauf qu’il est beaucoup plus rapide et ne peut pas lever d’exceptions.

Voir également qgetenv(), qEnvironmentVariable() et qEnvironmentVariableIsSet().

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

Renvoie la valeur numérique de la variable d'environnement « varName ». Si la variable n'est pas définie ou n'a pas pu être interprétée comme un entier, la fonction renvoie « std::nullopt ».

Similaire à

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

sauf qu'elle est beaucoup plus rapide et ne peut pas lever d'exceptions.

Si une valeur nulle est sémantiquement équivalente à une variable vide ou non définie, les applications peuvent utiliser

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

Notez toutefois que, dans ce cas, un échec d’analyse d’une valeur produira également un zéro.

Mais si une valeur nulle peut être utilisée pour désactiver certaines fonctionnalités, les applications peuvent comparer l’ std::optional e renvoyée à zéro, ce qui ne sera vrai que si la variable a été définie et contenait un nombre interprété comme zéro, comme dans :

   bool equals_zero = qEnvironmentVariableIntegerValue(varName) == 0;

Cette fonction a été introduite dans Qt 6.10.

Voir également ` qgetenv()`, ` qEnvironmentVariable()` et ` qEnvironmentVariableIsSet()`.

[noexcept] bool qEnvironmentVariableIsEmpty(const char *varName)

Indique si la variable d'environnement « varName » est vide.

Équivalent à

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

sauf qu’elle est potentiellement beaucoup plus rapide et ne peut pas lever d’exceptions.

Voir aussi qgetenv(), qEnvironmentVariable() et qEnvironmentVariableIsSet().

[noexcept] bool qEnvironmentVariableIsSet(const char *varName)

Indique si la variable d'environnement « varName » est définie.

Équivalent à

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

sauf qu’elle est potentiellement beaucoup plus rapide et ne peut pas lever d’exceptions.

Voir également qgetenv(), qEnvironmentVariable(), qEnvironmentVariableIsEmpty() et qEnvironmentVariableIntegerValue().

QByteArray qgetenv(const char *varName)

Renvoie la valeur de la variable d'environnement nommée « varName » sous la forme d'un objet ` QByteArray`. Si aucune variable de ce nom n'est trouvée dans l'environnement, cette fonction renvoie un objet ` QByteArray` construit par défaut.

Les fonctions de manipulation de l'environnement Qt sont sûres pour les threads, mais cela nécessite que les fonctions équivalentes de la bibliothèque C, telles que `getenv` et `putenv`, ne soient pas appelées directement.

Pour convertir les données en une chaîne de caractères de type ` QString `, utilisez ` QString::fromLocal8Bit()`.

Remarque : cette fonction est sûre pour les threads.

Voir également qputenv(), qEnvironmentVariable(), qEnvironmentVariableIsSet(), qEnvironmentVariableIsEmpty() et qEnvironmentVariableIntegerValue().

bool qputenv(const char *varName, QByteArrayView value)

value Cette fonction définit la valeur de la variable d'environnement nommée « varName ». Elle crée la variable si celle-ci n'existe pas. Elle renvoie 0 si la variable n'a pas pu être définie.

Appeler `qputenv` avec une valeur vide supprime la variable d’environnement sous Windows, et la définit (mais vide) sous Unix. Préférez utiliser ` qunsetenv()` pour un comportement entièrement portable.

Voir également qgetenv() et qEnvironmentVariable().

bool qunsetenv(const char *varName)

Cette fonction supprime la variable varName de l'environnement.

Renvoie « true » en cas de succès.

Voir également qputenv(), qgetenv() et qEnvironmentVariable().