<QtEnvironmentVariables>

Funktionsdokumentation

Diese Funktionen geben den Wert der Umgebungsvariable „ varName “ als „ QString “ zurück. Wird keine Variable „ varName “ in der Umgebung gefunden und ist „ defaultValue “ angegeben, wird „ defaultValue “ zurückgegeben. Andernfalls wird „QString()“ zurückgegeben.

Die Qt-Funktionen zur Bearbeitung der Umgebungsvariablen sind threadsicher, dies setzt jedoch voraus, dass die entsprechenden Funktionen der C-Bibliothek wie getenv und putenv nicht direkt aufgerufen werden.

Die folgende Tabelle beschreibt, wie man zwischen „ qgetenv()“ und „ qEnvironmentVariable()“ wählen sollte:

Siehe auch qputenv(), qgetenv(), qEnvironmentVariableIsSet(), qEnvironmentVariableIsEmpty() und qEnvironmentVariableIntegerValue().

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

Gibt den numerischen Wert der Umgebungsvariablen „ varName “ zurück. Wenn „ ok “ nicht null ist, wird „ *ok “ je nach Erfolg der Konvertierung auf „ true “ oder „ false “ gesetzt.

Entspricht

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

mit dem Unterschied, dass diese Funktion wesentlich schneller ist und keine Ausnahmen auslösen kann.

Siehe auch qgetenv(), qEnvironmentVariable() und qEnvironmentVariableIsSet().

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

Gibt den numerischen Wert der Umgebungsvariablen „ varName “ zurück. Wenn die Variable nicht gesetzt ist oder nicht als Ganzzahl ausgewertet werden konnte, wird „ std::nullopt “ zurückgegeben.

Ähnlich wie

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

, mit dem Unterschied, dass diese Funktion wesentlich schneller ist und keine Ausnahmen auslösen kann.

Wenn ein Wert von Null semantisch mit einer leeren oder nicht gesetzten Variablen gleichbedeutend ist, können Anwendungen

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

Beachten Sie in diesem Fall, dass auch Fehler beim Parsen eines Werts den Wert Null ergeben.

Wenn jedoch der Wert Null dazu verwendet werden kann, bestimmte Funktionen zu deaktivieren, können Anwendungen den zurückgegebenen Wert ` std::optional ` mit Null vergleichen, was nur dann wahr ist, wenn die Variable gesetzt war und eine Zahl enthielt, die als Null interpretiert wurde, wie in:

   bool equals_zero = qEnvironmentVariableIntegerValue(varName) == 0;

Diese Funktion wurde in Qt 6.10 eingeführt.

Siehe auch „ qgetenv()“, „ qEnvironmentVariable()“ und „ qEnvironmentVariableIsSet()“.

[noexcept] bool qEnvironmentVariableIsEmpty(const char *varName)

Gibt zurück, ob die Umgebungsvariable „ varName “ leer ist.

Entspricht

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

, mit dem Unterschied, dass diese Funktion potenziell wesentlich schneller ist und keine Ausnahmen auslösen kann.

Siehe auch qgetenv(), qEnvironmentVariable() und qEnvironmentVariableIsSet().

[noexcept] bool qEnvironmentVariableIsSet(const char *varName)

Gibt zurück, ob die Umgebungsvariable „ varName “ gesetzt ist.

Entspricht

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

, mit dem Unterschied, dass diese Funktion potenziell wesentlich schneller ist und keine Ausnahmen auslösen kann.

Siehe auch qgetenv(), qEnvironmentVariable(), qEnvironmentVariableIsEmpty() und qEnvironmentVariableIntegerValue().

QByteArray qgetenv(const char *varName)

Gibt den Wert der Umgebungsvariablen mit dem Namen „ varName “ als „ QByteArray “ zurück. Wird in der Umgebung keine Variable mit diesem Namen gefunden, gibt diese Funktion ein standardkonstruiertes „ QByteArray “ zurück.

Die Qt-Funktionen zur Bearbeitung der Umgebungsvariablen sind threadsicher, dies setzt jedoch voraus, dass die entsprechenden Funktionen der C-Bibliothek wie „getenv“ und „putenv“ nicht direkt aufgerufen werden.

Um die Daten in eine ` QString ` zu konvertieren, verwende ` QString::fromLocal8Bit()`.

Hinweis: Diese Funktion ist threadsicher.

Siehe auch qputenv(), qEnvironmentVariable(), qEnvironmentVariableIsSet(), qEnvironmentVariableIsEmpty() und qEnvironmentVariableIntegerValue().

bool qputenv(const char *varName, QByteArrayView value)

Diese Funktion setzt den Wert „ value “ der Umgebungsvariablen „ varName “. Die Variable wird angelegt, falls sie noch nicht existiert. Die Funktion gibt 0 zurück, wenn die Variable nicht gesetzt werden konnte.

Der Aufruf von `qputenv` mit einem leeren Wert entfernt die Umgebungsvariable unter Windows und setzt sie unter Unix (allerdings leer). Verwenden Sie für ein vollständig portables Verhalten vorzugsweise ` qunsetenv()`.

Siehe auch qgetenv() und qEnvironmentVariable().

bool qunsetenv(const char *varName)

Diese Funktion löscht die Variable „ varName “ aus der Umgebung.

Gibt bei Erfolg „ true “ zurück.

Siehe auch „ qputenv()“, „ qgetenv()“ und „ qEnvironmentVariable()“.