QProcess Class

Member Function Documentation

[explicit] QProcess::QProcess(QObject *parent = nullptr)

Constructs a QProcess object with the given parent.

[virtual] QProcess::~QProcess()

Destructs the QProcess object, i.e., killing the process.

Note that this function will not return until the process is terminated.

QStringList QProcess::arguments() const

Returns the command line arguments the process was last started with.

See also setArguments() and start().

[override virtual] qint64 QProcess::bytesToWrite() const

Reimplements: QIODevice::bytesToWrite() const.

[since 6.0] std::function<void ()> QProcess::childProcessModifier() const

Returns the modifier function previously set by calling setChildProcessModifier().

This function was introduced in Qt 6.0.

See also setChildProcessModifier().

[override virtual] void QProcess::close()

Reimplements: QIODevice::close().

Closes all communication with the process and kills it. After calling this function, QProcess will no longer emit readyRead(), and data can no longer be read or written.

void QProcess::closeReadChannel(QProcess::ProcessChannel channel)

Closes the read channel channel. After calling this function, QProcess will no longer receive data on the channel. Any data that has already been received is still available for reading.

Call this function to save memory, if you are not interested in the output of the process.

See also closeWriteChannel() and setReadChannel().

void QProcess::closeWriteChannel()

Schedules the write channel of QProcess to be closed. The channel will close once all data has been written to the process. After calling this function, any attempts to write to the process will fail.

Closing the write channel is necessary for programs that read input data until the channel has been closed. For example, the program "more" is used to display text data in a console on both Unix and Windows. But it will not display the text data until QProcess's write channel has been closed. Example:

QProcess more;
more.start("more");
more.write("Text to display");
more.closeWriteChannel();
// QProcess will emit readyRead() once "more" starts printing

The write channel is implicitly opened when start() is called.

See also closeReadChannel().

QProcess::CreateProcessArgumentModifier QProcess::createProcessArgumentsModifier() const

Returns a previously set CreateProcess modifier function.

See also setCreateProcessArgumentsModifier() and QProcess::CreateProcessArgumentModifier.

QProcess::ProcessError QProcess::error() const

Returns the type of error that occurred last.

See also state().

[signal] void QProcess::errorOccurred(QProcess::ProcessError error)

This signal is emitted when an error occurs with the process. The specified error describes the type of error that occurred.

[static] int QProcess::execute(const QString &program, const QStringList &arguments = {})

Starts the program program with the arguments arguments in a new process, waits for it to finish, and then returns the exit code of the process. Any data the new process writes to the console is forwarded to the calling process.

The environment and working directory are inherited from the calling process.

Argument handling is identical to the respective start() overload.

If the process cannot be started, -2 is returned. If the process crashes, -1 is returned. Otherwise, the process' exit code is returned.

See also start().

int QProcess::exitCode() const

Returns the exit code of the last process that finished.

This value is not valid unless exitStatus() returns NormalExit.

QProcess::ExitStatus QProcess::exitStatus() const

Returns the exit status of the last process that finished.

On Windows, if the process was terminated with TerminateProcess() from another application, this function will still return NormalExit unless the exit code is less than 0.

[signal] void QProcess::finished(int exitCode, QProcess::ExitStatus exitStatus = NormalExit)

This signal is emitted when the process finishes. exitCode is the exit code of the process (only valid for normal exits), and exitStatus is the exit status. After the process has finished, the buffers in QProcess are still intact. You can still read any data that the process may have written before it finished.

See also exitStatus().

QProcess::InputChannelMode QProcess::inputChannelMode() const

Returns the channel mode of the QProcess standard input channel.

See also setInputChannelMode() and InputChannelMode.

[override virtual] bool QProcess::isSequential() const

Reimplements: QIODevice::isSequential() const.

[slot] void QProcess::kill()

Kills the current process, causing it to exit immediately.

On Windows, kill() uses TerminateProcess, and on Unix and macOS, the SIGKILL signal is sent to the process.

See also terminate().

QString QProcess::nativeArguments() const

Returns the additional native command line arguments for the program.

See also setNativeArguments().

[static] QString QProcess::nullDevice()

The null device of the operating system.

The returned file path uses native directory separators.

See also QProcess::setStandardInputFile(), QProcess::setStandardOutputFile(), and QProcess::setStandardErrorFile().

[override virtual] bool QProcess::open(QIODeviceBase::OpenMode mode = ReadWrite)

Reimplements: QIODevice::open(QIODeviceBase::OpenMode mode).

Starts the program set by setProgram() with arguments set by setArguments(). The OpenMode is set to mode.

This method is an alias for start(), and exists only to fully implement the interface defined by QIODevice.

Returns true if the program has been started.

See also start(), setProgram(), and setArguments().

QProcess::ProcessChannelMode QProcess::processChannelMode() const

Returns the channel mode of the QProcess standard output and standard error channels.

See also setProcessChannelMode(), ProcessChannelMode, and setReadChannel().

QProcessEnvironment QProcess::processEnvironment() const

Returns the environment that QProcess will pass to its child process. If no environment has been set using setProcessEnvironment(), this method returns an object indicating the environment will be inherited from the parent.

See also setProcessEnvironment(), QProcessEnvironment::inheritsFromParent(), and Environment variables.

qint64 QProcess::processId() const

Returns the native process identifier for the running process, if available. If no process is currently running, 0 is returned.

QString QProcess::program() const

Returns the program the process was last started with.

See also setProgram() and start().

QByteArray QProcess::readAllStandardError()

Regardless of the current read channel, this function returns all data available from the standard error of the process as a QByteArray.

See also readyReadStandardError(), readAllStandardOutput(), readChannel(), and setReadChannel().

QByteArray QProcess::readAllStandardOutput()

Regardless of the current read channel, this function returns all data available from the standard output of the process as a QByteArray.

See also readyReadStandardOutput(), readAllStandardError(), readChannel(), and setReadChannel().

QProcess::ProcessChannel QProcess::readChannel() const

Returns the current read channel of the QProcess.

See also setReadChannel().

[override virtual protected] qint64 QProcess::readData(char *data, qint64 maxlen)

Reimplements: QIODevice::readData(char *data, qint64 maxSize).

[private signal] void QProcess::readyReadStandardError()

This signal is emitted when the process has made new data available through its standard error channel (stderr). It is emitted regardless of the current read channel.

See also readAllStandardError() and readChannel().

[private signal] void QProcess::readyReadStandardOutput()

This signal is emitted when the process has made new data available through its standard output channel (stdout). It is emitted regardless of the current read channel.

See also readAllStandardOutput() and readChannel().

void QProcess::setArguments(const QStringList &arguments)

Set the arguments to pass to the called program when starting the process. This function must be called before start().

See also start(), setProgram(), and arguments().

[since 6.0] void QProcess::setChildProcessModifier(const std::function<void ()> &modifier)

Sets the modifier function for the child process, for Unix systems (including macOS; for Windows, see setCreateProcessArgumentsModifier()). The function contained by the modifier argument will be invoked in the child process after fork() or vfork() is completed and QProcess has set up the standard file descriptors for the child process, but before execve(), inside start(). The modifier is useful to change certain properties of the child process, such as setting up additional file descriptors or closing others, changing the nice level, disconnecting from the controlling TTY, etc.

The following shows an example of setting up a child process to run without privileges:

void runSandboxed(const QString &name, const QStringList &arguments)
{
    QProcess proc;
    proc.setChildProcessModifier([] {
        // Drop all privileges in the child process, and enter
        // a chroot jail.
        ::setgroups(0, nullptr);
        ::chroot("/run/safedir");
        ::chdir("/");
        ::setgid(safeGid);
        ::setuid(safeUid);
        ::umask(077);
    });
    proc.start(name, arguments);
    proc.waitForFinished();
}

If the modifier function needs to exit the process, remember to use _exit(), not exit().

This function was introduced in Qt 6.0.

See also childProcessModifier().

void QProcess::setCreateProcessArgumentsModifier(QProcess::CreateProcessArgumentModifier modifier)

Sets the modifier for the CreateProcess Win32 API call. Pass QProcess::CreateProcessArgumentModifier() to remove a previously set one.

See also createProcessArgumentsModifier(), QProcess::CreateProcessArgumentModifier, and setChildProcessModifier().

void QProcess::setInputChannelMode(QProcess::InputChannelMode mode)

Sets the channel mode of the QProcess standard input channel to the mode specified. This mode will be used the next time start() is called.

See also inputChannelMode() and InputChannelMode.

void QProcess::setNativeArguments(const QString &arguments)

This is an overloaded function.

Sets additional native command line arguments for the program.

On operating systems where the system API for passing command line arguments to a subprocess natively uses a single string, one can conceive command lines which cannot be passed via QProcess's portable list-based API. In such cases this function must be used to set a string which is appended to the string composed from the usual argument list, with a delimiting space.

See also nativeArguments().

void QProcess::setProcessChannelMode(QProcess::ProcessChannelMode mode)

Sets the channel mode of the QProcess standard output and standard error channels to the mode specified. This mode will be used the next time start() is called. For example:

QProcess builder;
builder.setProcessChannelMode(QProcess::MergedChannels);
builder.start("make", QStringList() << "-j2");

if (!builder.waitForFinished())
    qDebug() << "Make failed:" << builder.errorString();
else
    qDebug() << "Make output:" << builder.readAll();

See also processChannelMode(), ProcessChannelMode, and setReadChannel().

void QProcess::setProcessEnvironment(const QProcessEnvironment &environment)

Sets the environment that QProcess will pass to the child process.

For example, the following code adds the environment variable TMPDIR:

QProcess process;
QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
env.insert("TMPDIR", "C:\\MyApp\\temp"); // Add an environment variable
process.setProcessEnvironment(env);
process.start("myapp");

Note how, on Windows, environment variable names are case-insensitive.

See also processEnvironment(), QProcessEnvironment::systemEnvironment(), and Environment variables.

[protected] void QProcess::setProcessState(QProcess::ProcessState state)

Sets the current state of the QProcess to the state specified.

See also state().

void QProcess::setProgram(const QString &program)

Set the program to use when starting the process. This function must be called before start().

If program is an absolute path, it specifies the exact executable that will be launched. Relative paths will be resolved in a platform-specific manner, which includes searching the PATH environment variable (see Finding the Executable for details).

See also start(), setArguments(), program(), and QStandardPaths::findExecutable().

void QProcess::setReadChannel(QProcess::ProcessChannel channel)

Sets the current read channel of the QProcess to the given channel. The current input channel is used by the functions read(), readAll(), readLine(), and getChar(). It also determines which channel triggers QProcess to emit readyRead().

See also readChannel().

void QProcess::setStandardErrorFile(const QString &fileName, QIODeviceBase::OpenMode mode = Truncate)

Redirects the process' standard error to the file fileName. When the redirection is in place, the standard error read channel is closed: reading from it using read() will always fail, as will readAllStandardError(). The file will be appended to if mode is Append, otherwise, it will be truncated.

See setStandardOutputFile() for more information on how the file is opened.

Note: if setProcessChannelMode() was called with an argument of QProcess::MergedChannels, this function has no effect.

See also setStandardInputFile(), setStandardOutputFile(), and setStandardOutputProcess().

void QProcess::setStandardInputFile(const QString &fileName)

Redirects the process' standard input to the file indicated by fileName. When an input redirection is in place, the QProcess object will be in read-only mode (calling write() will result in error).

To make the process read EOF right away, pass nullDevice() here. This is cleaner than using closeWriteChannel() before writing any data, because it can be set up prior to starting the process.

If the file fileName does not exist at the moment start() is called or is not readable, starting the process will fail.

Calling setStandardInputFile() after the process has started has no effect.

See also setStandardOutputFile(), setStandardErrorFile(), and setStandardOutputProcess().

void QProcess::setStandardOutputFile(const QString &fileName, QIODeviceBase::OpenMode mode = Truncate)

Redirects the process' standard output to the file fileName. When the redirection is in place, the standard output read channel is closed: reading from it using read() will always fail, as will readAllStandardOutput().

To discard all standard output from the process, pass nullDevice() here. This is more efficient than simply never reading the standard output, as no QProcess buffers are filled.

If the file fileName doesn't exist at the moment start() is called, it will be created. If it cannot be created, the starting will fail.

If the file exists and mode is QIODevice::Truncate, the file will be truncated. Otherwise (if mode is QIODevice::Append), the file will be appended to.

Calling setStandardOutputFile() after the process has started has no effect.

If fileName is an empty string, it stops redirecting the standard output. This is useful for restoring the standard output after redirection.

See also setStandardInputFile(), setStandardErrorFile(), and setStandardOutputProcess().

void QProcess::setStandardOutputProcess(QProcess *destination)

Pipes the standard output stream of this process to the destination process' standard input.

The following shell command:

command1 | command2

Can be accomplished with QProcess with the following code:

QProcess process1;
QProcess process2;

process1.setStandardOutputProcess(&process2);

process1.start("command1");
process2.start("command2");

void QProcess::setWorkingDirectory(const QString &dir)

Sets the working directory to dir. QProcess will start the process in this directory. The default behavior is to start the process in the working directory of the calling process.

See also workingDirectory() and start().

[static] QStringList QProcess::splitCommand(QStringView command)

Splits the string command into a list of tokens, and returns the list.

Tokens with spaces can be surrounded by double quotes; three consecutive double quotes represent the quote character itself.

void QProcess::start(const QString &program, const QStringList &arguments = {}, QIODeviceBase::OpenMode mode = ReadWrite)

Starts the given program in a new process, passing the command line arguments in arguments. See setProgram() for information about how QProcess searches for the executable to be run. The OpenMode is set to mode. No further splitting of the arguments is performed.

The QProcess object will immediately enter the Starting state. If the process starts successfully, QProcess will emit started(); otherwise, errorOccurred() will be emitted. Do note that on platforms that are able to start child processes synchronously (notably Windows), those signals will be emitted before this function returns and this QProcess object will transition to either QProcess::Running or QProcess::NotRunning state, respectively. On others paltforms, the started() and errorOccurred() signals will be delayed.

Call waitForStarted() to make sure the process has started (or has failed to start) and those signals have been emitted. It is safe to call that function even if the process starting state is already known, though the signal will not be emitted again.

Windows: The arguments are quoted and joined into a command line that is compatible with the CommandLineToArgvW() Windows function. For programs that have different command line quoting requirements, you need to use setNativeArguments(). One notable program that does not follow the CommandLineToArgvW() rules is cmd.exe and, by consequence, all batch scripts.

If the QProcess object is already running a process, a warning may be printed at the console, and the existing process will continue running unaffected.

See also processId(), started(), waitForStarted(), and setNativeArguments().

void QProcess::start(QIODeviceBase::OpenMode mode = ReadWrite)

This is an overloaded function.

Starts the program set by setProgram() with arguments set by setArguments(). The OpenMode is set to mode.

See also open(), setProgram(), and setArguments().

[since 6.0] void QProcess::startCommand(const QString &command, QIODeviceBase::OpenMode mode = ReadWrite)

Starts the command command in a new process. The OpenMode is set to mode.

command is a single string of text containing both the program name and its arguments. The arguments are separated by one or more spaces. For example:

QProcess process;
process.startCommand("del /s *.txt");
// same as process.start("del", QStringList() << "/s" << "*.txt");
...

Arguments containing spaces must be quoted to be correctly supplied to the new process. For example:

QProcess process;
process.startCommand("dir \"My Documents\"");

Literal quotes in the command string are represented by triple quotes. For example:

QProcess process;
process.startCommand("dir \"Epic 12\"\"\" Singles\"");

After the command string has been split and unquoted, this function behaves like start().

On operating systems where the system API for passing command line arguments to a subprocess natively uses a single string (Windows), one can conceive command lines which cannot be passed via QProcess's portable list-based API. In these rare cases you need to use setProgram() and setNativeArguments() instead of this function.

This function was introduced in Qt 6.0.

See also splitCommand() and start().

bool QProcess::startDetached(qint64 *pid = nullptr)

Starts the program set by setProgram() with arguments set by setArguments() in a new process, and detaches from it. Returns true on success; otherwise returns false. If the calling process exits, the detached process will continue to run unaffected.

Unix: The started process will run in its own session and act like a daemon.

The process will be started in the directory set by setWorkingDirectory(). If workingDirectory() is empty, the working directory is inherited from the calling process.

If the function is successful then *pid is set to the process identifier of the started process; otherwise, it's set to -1. Note that the child process may exit and the PID may become invalid without notice. Furthermore, after the child process exits, the same PID may be recycled and used by a completely different process. User code should be careful when using this variable, especially if one intends to forcibly terminate the process by operating system means.

Only the following property setters are supported by startDetached():

• setArguments()
• setCreateProcessArgumentsModifier()
• setNativeArguments()
• setProcessEnvironment()
• setProgram()
• setStandardErrorFile()
• setStandardInputFile()
• setStandardOutputFile()
• setProcessChannelMode(QProcess::MergedChannels)
• setStandardOutputProcess()
• setWorkingDirectory()

All other properties of the QProcess object are ignored.

See also start() and startDetached(const QString &program, const QStringList &arguments, const QString &workingDirectory, qint64 *pid).

[static] bool QProcess::startDetached(const QString &program, const QStringList &arguments = {}, const QString &workingDirectory = QString(), qint64 *pid = nullptr)

This function overloads startDetached().

Starts the program program with the arguments arguments in a new process, and detaches from it. Returns true on success; otherwise returns false. If the calling process exits, the detached process will continue to run unaffected.

Argument handling is identical to the respective start() overload.

The process will be started in the directory workingDirectory. If workingDirectory is empty, the working directory is inherited from the calling process.

If the function is successful then *pid is set to the process identifier of the started process.

See also start().

[private signal] void QProcess::started()

This signal is emitted by QProcess when the process has started, and state() returns Running.

QProcess::ProcessState QProcess::state() const

Returns the current state of the process.

See also stateChanged() and error().

[private signal] void QProcess::stateChanged(QProcess::ProcessState newState)

This signal is emitted whenever the state of QProcess changes. The newState argument is the state QProcess changed to.

[static] QStringList QProcess::systemEnvironment()

Returns the environment of the calling process as a list of key=value pairs. Example:

QStringList environment = QProcess::systemEnvironment();
// environment = {"PATH=/usr/bin:/usr/local/bin",
//                "USER=greg", "HOME=/home/greg"}

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 list of environment variables, which is a non-trivial operation.

See also QProcessEnvironment::systemEnvironment() and setProcessEnvironment().

[slot] void QProcess::terminate()

Attempts to terminate the process.

The process may not exit as a result of calling this function (it is given the chance to prompt the user for any unsaved files, etc).

On Windows, terminate() posts a WM_CLOSE message to all top-level windows of the process and then to the main thread of the process itself. On Unix and macOS the SIGTERM signal is sent.

Console applications on Windows that do not run an event loop, or whose event loop does not handle the WM_CLOSE message, can only be terminated by calling kill().

See also kill().

[override virtual] bool QProcess::waitForBytesWritten(int msecs = 30000)

Reimplements: QIODevice::waitForBytesWritten(int msecs).

bool QProcess::waitForFinished(int msecs = 30000)

Blocks until the process has finished and the finished() signal has been emitted, or until msecs milliseconds have passed.

Returns true if the process finished; otherwise returns false (if the operation timed out, if an error occurred, or if this QProcess is already finished).

This function can operate without an event loop. It is useful when writing non-GUI applications and when performing I/O operations in a non-GUI thread.

If msecs is -1, this function will not time out.

See also finished(), waitForStarted(), waitForReadyRead(), and waitForBytesWritten().

[override virtual] bool QProcess::waitForReadyRead(int msecs = 30000)

Reimplements: QIODevice::waitForReadyRead(int msecs).

bool QProcess::waitForStarted(int msecs = 30000)

Blocks until the process has started and the started() signal has been emitted, or until msecs milliseconds have passed.

Returns true if the process was started successfully; otherwise returns false (if the operation timed out or if an error occurred). If the process had already started successfully before this function, it returns immediately.

This function can operate without an event loop. It is useful when writing non-GUI applications and when performing I/O operations in a non-GUI thread.

If msecs is -1, this function will not time out.

See also started(), waitForReadyRead(), waitForBytesWritten(), and waitForFinished().

QString QProcess::workingDirectory() const

If QProcess has been assigned a working directory, this function returns the working directory that the QProcess will enter before the program has started. Otherwise, (i.e., no directory has been assigned,) an empty string is returned, and QProcess will use the application's current working directory instead.

See also setWorkingDirectory().

[override virtual protected] qint64 QProcess::writeData(const char *data, qint64 len)

Reimplements: QIODevice::writeData(const char *data, qint64 maxSize).