include/QtCore/qtenvironmentvariables.h

0001 // Copyright (C) 2022 The Qt Company Ltd.
0002 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0003
0004 #ifndef QTENVIRONMENTVARIABLES_H
0005 #define QTENVIRONMENTVARIABLES_H
0006
0007 #include <QtCore/qtconfigmacros.h>
0008 #include <QtCore/qtcoreexports.h>
0009 #include <QtCore/qtdeprecationmarkers.h>
0010
0011 #if 0
0012 #pragma qt_class(QtEnvironmentVariables)
0013 #pragma qt_sync_stop_processing
0014 #endif
0015
0016 QT_BEGIN_NAMESPACE
0017
0018 class QByteArray;
0019 class QByteArrayView;
0020 class QString;
0021
0022 Q_CORE_EXPORT QByteArray qgetenv(const char *varName);
0023 // need it as two functions because QString is only forward-declared here
0024 Q_CORE_EXPORT QString qEnvironmentVariable(const char *varName);
0025 Q_CORE_EXPORT QString qEnvironmentVariable(const char *varName, const QString &defaultValue);
0026 #if QT_CORE_REMOVED_SINCE(6, 5)
0027 Q_CORE_EXPORT bool qputenv(const char *varName, const QByteArray &value);
0028 #endif
0029 Q_CORE_EXPORT bool qputenv(const char *varName, QByteArrayView value);
0030 Q_CORE_EXPORT bool qunsetenv(const char *varName);
0031
0032 Q_CORE_EXPORT bool qEnvironmentVariableIsEmpty(const char *varName) noexcept;
0033 Q_CORE_EXPORT bool qEnvironmentVariableIsSet(const char *varName) noexcept;
0034 Q_CORE_EXPORT int  qEnvironmentVariableIntValue(const char *varName, bool *ok=nullptr) noexcept;
0035
0036 QT_END_NAMESPACE
0037
0038 #endif /* QTENVIRONMENTVARIABLES_H */