Класс QProcessEnvironment

Класс QProcessEnvironment хранит переменные окружения, которые могут быть переданы программе. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются реентерабельными.

Открытые функции

Статические открытые члены

Подробное описание

Класс QProcessEnvironment хранит переменные окружения, которые могут быть переданы программе.

Окружение процесса состоит из набора пар «ключ=значение», известных как переменные окружения. Класс QProcessEnvironment оборачивает это понятие и позволяет легко манипулировать этими переменными. Он предназначен для использования совместно с QProcess для установки окружения дочерних процессов. Он не может использоваться для изменения окружения текущего процесса.

Окружение вызывающего процесса можно получить с помощью QProcessEnvironment::systemEnvironment().

В системах Unix имена переменных чувствительны к регистру. Обратите внимание, что окружение Unix допускает использование в именах и значениях переменных произвольных бинарных данных (кроме символа NUL). QProcessEnvironment сохранит такие переменные, но не поддерживает манипулирование переменными, имена или значения которых не могут быть закодированы текущими настройками локалей (см. QTextCodec::codecForLocale).

В Windows имена переменных нечувствительны к регистру, но сохраняют регистр. QProcessEnvironment ведет себя соответствующим образом.

См. также QProcess, QProcess::systemEnvironment() и QProcess::setProcessEnvironment().

Документация по функциям-членам

QProcessEnvironment::QProcessEnvironment()

Создает новый объект QProcessEnvironment. Этот конструктор создаёт пустое окружение. Если он установлен в QProcess, это приведёт к удалению текущих переменных окружения.

QProcessEnvironment::QProcessEnvironment(const QProcessEnvironment &other)

Создаёт объект QProcessEnvironment, являющийся копией other.

QProcessEnvironment::~QProcessEnvironment()

Освобождает ресурсы, связанные с этим объектом QProcessEnvironment.

void QProcessEnvironment::clear()

Удаляет все пары «ключ=значение» из объекта QProcessEnvironment, делая его пустым.

См. также isEmpty() и systemEnvironment().

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

Возвращает true если переменная окружения с именем name найдена в этом объекте QProcessEnvironment.

См. также insert() и value().

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, будут перезаписаны.

Эта функция была добавлена в Qt 4.8.

bool QProcessEnvironment::isEmpty() const

Возвращает true если этот объект QProcessEnvironment пуст: то есть нет пар «ключ=значение».

См. также clear(), systemEnvironment() и insert().

QStringList QProcessEnvironment::keys() const

Возвращает список, содержащий все имена переменных в этом объекте QProcessEnvironment.

Эта функция была добавлена в Qt 4.8.

void QProcessEnvironment::remove(const QString &name)

Удаляет переменную окружения, идентифицированную по имени name, из этого объекта QProcessEnvironment. Если такая переменная не существовала ранее, ничего не происходит.

См. также contains(), insert() и value().

void QProcessEnvironment::swap(QProcessEnvironment &other)

Меняет местами этот экземпляр окружения процесса с other. Эта функция очень быстрая и никогда не терпит неудачу.

Эта функция была добавлена в Qt 5.0.

QProcessEnvironment QProcessEnvironment::systemEnvironment()

Функция systemEnvironment возвращает окружение вызывающего процесса.

Он возвращается как QProcessEnvironment. Данная функция не кэширует системную среду. Поэтому возможно получить обновлённую версию среды, если были вызваны функции низкоуровневой C-библиотеки, такие как setenv или putenv.

Однако обратите внимание, что повторные вызовы этой функции приведут к повторному созданию объекта QProcessEnvironment, что является нетривиальной операцией.

Эта функция была добавлена в Qt 4.6.

См. также 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().

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

Возвращает true, если этот и объект other QProcessEnvironment отличаются.

См. также operator==().

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

Оператор присваивания перемещения.

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

Копирует содержимое объекта other QProcessEnvironment в этот объект.

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

Возвращает true, если этот и объект other QProcessEnvironment равны.

Два объекта QProcessEnvironment считаются равными, если они имеют тот же набор пар ключ=значение. Сравнение ключей выполняется чувствительно к регистру на платформах, где среда чувствительна к регистру.

См. также operator!=() и contains().