Skip to content

PythonQt.QtCore.QProcessEnvironment · declarations 001

Back to PythonQt.QtCore.QProcessEnvironment

clear

clear() -> None

X.clear()

Supplemental documentation: Qt 5 reference:

void QProcessEnvironment::clear()

Removes all key\=value pairs from this QProcessEnvironment object, making it empty.

See also isEmpty() and systemEnvironment().

Upstream PySide2 reference signatures (binding differences may apply):

clear(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#clear

contains

contains(name: str) -> bool

X.contains(name) -> bool

Supplemental documentation: Qt 5 reference:

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

Returns true if the environment variable of name name is found in this QProcessEnvironment object.

See also insert() and value().

Upstream PySide2 reference signatures (binding differences may apply):

contains(self, name: str) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#contains

insert

insert(name: Any, value: Any) -> None

X.insert(name, value)

Supplemental documentation: Qt 5 reference:

void QProcessEnvironment::insert(const QString \&name, const QString \&value)

Inserts the environment variable of name name and contents value into this QProcessEnvironment object. If that variable already existed, it is replaced by the new value.

On most systems, inserting a variable with no contents will have the same effect for applications as if the variable had not been set at all. However, to guarantee that there are no incompatibilities, to remove a variable, please use the remove() function.

See also contains(), remove(), and value().

void QProcessEnvironment::insert(const QProcessEnvironment \&e)

This is an overloaded function.

Inserts the contents of e in this QProcessEnvironment object. Variables in this object that also exist in e will be overwritten.

This function was introduced in Qt 4.8.

Upstream PySide2 reference signatures (binding differences may apply):

insert(self, e: PySide2.QtCore.QProcessEnvironment) -> None
insert(self, name: str, value: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#insert

isEmpty

isEmpty() -> bool

X.isEmpty() -> bool

Supplemental documentation: Qt 5 reference:

bool QProcessEnvironment::isEmpty() const

Returns true if this QProcessEnvironment object is empty: that is there are no key\=value pairs set.

See also clear(), systemEnvironment(), and insert().

Upstream PySide2 reference signatures (binding differences may apply):

isEmpty(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#isEmpty

keys

keys() -> tuple

X.keys() -> tuple

Supplemental documentation: Qt 5 reference:

QStringList QProcessEnvironment::keys() const

Returns a list containing all the variable names in this QProcessEnvironment object.

This function was introduced in Qt 4.8.

Upstream PySide2 reference signatures (binding differences may apply):

keys(self) -> typing.List[str]

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#keys

operator_assign

operator_assign(other: Any) -> Any

X.operator_assign(other) -> PythonQt.QtCore.QProcessEnvironment

remove

remove(name: str) -> None

X.remove(name)

Supplemental documentation: Qt 5 reference:

void QProcessEnvironment::remove(const QString \&name)

Removes the environment variable identified by name from this QProcessEnvironment object. If that variable did not exist before, nothing happens.

See also contains(), insert(), and value().

Upstream PySide2 reference signatures (binding differences may apply):

remove(self, name: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#remove

swap

swap(other: Any) -> None

X.swap(other)

Supplemental documentation: Qt 5 reference:

void QProcessEnvironment::swap(QProcessEnvironment \&other)

Swaps this process environment instance with other. This function is very fast and never fails.

This function was introduced in Qt 5.0.

Upstream PySide2 reference signatures (binding differences may apply):

swap(self, other: PySide2.QtCore.QProcessEnvironment) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#swap

systemEnvironment

systemEnvironment() -> Any

X.systemEnvironment() -> PythonQt.QtCore.QProcessEnvironment

Supplemental documentation: Qt 5 reference:

[static] QProcessEnvironment QProcessEnvironment::systemEnvironment()

The systemEnvironment function returns the environment of the calling process.

It is returned as a QProcessEnvironment. This function does not cache the system environment. Therefore, it's possible to obtain an updated version of the environment if low-level C library functions like setenv or putenv have been called.

However, note that repeated calls to this function will recreate the QProcessEnvironment object, which is a non-trivial operation.

This function was introduced in Qt 4.6.

See also QProcess::systemEnvironment().

Upstream PySide2 reference signatures (binding differences may apply):

systemEnvironment() -> PySide2.QtCore.QProcessEnvironment

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#systemEnvironment

toStringList

toStringList() -> tuple

X.toStringList() -> tuple

Supplemental documentation: Qt 5 reference:

QStringList QProcessEnvironment::toStringList() const

Converts this QProcessEnvironment object into a list of strings, one for each environment variable that is set. The environment variable's name and its value are separated by an equal character ('\=').

The QStringList contents returned by this function are suitable for presentation. Use with the QProcess::setEnvironment function is not recommended due to potential encoding problems under Unix, and worse performance.

See also systemEnvironment(), QProcess::systemEnvironment(), and QProcess::setProcessEnvironment().

Upstream PySide2 reference signatures (binding differences may apply):

toStringList(self) -> typing.List[str]

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#toStringList

value

value(name: str, defaultValue: str) -> str

X.value(name, defaultValue) -> str

Supplemental documentation: Qt 5 reference:

QString QProcessEnvironment::value(const QString \&name, const QString \&defaultValue \= QString()) const

Searches this QProcessEnvironment object for a variable identified by name and returns its value. If the variable is not found in this object, then defaultValue is returned instead.

See also contains(), insert(), and remove().

Upstream PySide2 reference signatures (binding differences may apply):

value(self, name: str, defaultValue: str=...) -> str

Source: https://doc.qt.io/archives/qt-5.15/qprocessenvironment.html#value