QProcess 类

QProcess 类用于启动外部程序并与之通信。 更多...

Header: #include <QProcess>
CMake: find_package(Qt6 COMPONENTS Core REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
继承: QIODevice

注意: 此类的所有函数 可重入 .

公共类型

struct CreateProcessArguments
CreateProcessArgumentModifier
enum ExitStatus { NormalExit, CrashExit }
enum InputChannelMode { ManagedInputChannel, ForwardedInputChannel }
enum ProcessChannel { StandardOutput, StandardError }
enum ProcessChannelMode { SeparateChannels, MergedChannels, ForwardedChannels, ForwardedErrorChannel, ForwardedOutputChannel }
enum ProcessError { FailedToStart, Crashed, Timedout, WriteError, ReadError, UnknownError }
enum ProcessState { NotRunning, Starting, Running }

公共函数

QProcess (QObject * parent = nullptr)
virtual ~QProcess ()
QStringList arguments () const
std::function<void ()> childProcessModifier () const
void closeReadChannel (QProcess::ProcessChannel channel )
void closeWriteChannel ()
QProcess::CreateProcessArgumentModifier createProcessArgumentsModifier () const
QProcess::ProcessError error () const
int exitCode () const
QProcess::ExitStatus exitStatus () const
QProcess::InputChannelMode inputChannelMode () const
QString nativeArguments () const
QProcess::ProcessChannelMode processChannelMode () const
QProcessEnvironment processEnvironment () const
qint64 processId () const
QString program () const
QByteArray readAllStandardError ()
QByteArray readAllStandardOutput ()
QProcess::ProcessChannel readChannel () const
void setArguments (const QStringList & arguments )
void setChildProcessModifier (const std::function<void ()> & modifier )
void setCreateProcessArgumentsModifier (QProcess::CreateProcessArgumentModifier modifier )
void setInputChannelMode (QProcess::InputChannelMode mode )
void setNativeArguments (const QString & arguments )
void setProcessChannelMode (QProcess::ProcessChannelMode mode )
void setProcessEnvironment (const QProcessEnvironment & environment )
void setProgram (const QString & program )
void setReadChannel (QProcess::ProcessChannel channel )
void setStandardErrorFile (const QString & fileName , QIODeviceBase::OpenMode mode = Truncate)
void setStandardInputFile (const QString & fileName )
void setStandardOutputFile (const QString & fileName , QIODeviceBase::OpenMode mode = Truncate)
void setStandardOutputProcess (QProcess * destination )
void setWorkingDirectory (const QString & dir )
void start (const QString & program , const QStringList & arguments = {}, QIODeviceBase::OpenMode mode = ReadWrite)
void start (QIODeviceBase::OpenMode mode = ReadWrite)
void startCommand (const QString & command , QIODeviceBase::OpenMode mode = ReadWrite)
bool startDetached (qint64 * pid = nullptr)
QProcess::ProcessState state () const
bool waitForFinished (int msecs = 30000)
bool waitForStarted (int msecs = 30000)
QString workingDirectory () const

重实现公共函数

virtual qint64 bytesToWrite () const override
virtual void close () override
virtual bool isSequential () const override
virtual bool open (QIODeviceBase::OpenMode mode = ReadWrite) override
virtual bool waitForBytesWritten (int msecs = 30000) override
virtual bool waitForReadyRead (int msecs = 30000) override

公共槽

void kill ()
void terminate ()

信号

void errorOccurred (QProcess::ProcessError error )
void finished (int exitCode , QProcess::ExitStatus exitStatus = NormalExit)
void readyReadStandardError ()
void readyReadStandardOutput ()
void started ()
void stateChanged (QProcess::ProcessState newState )

静态公共成员

int execute (const QString & program , const QStringList & arguments = {})
QString nullDevice ()
QStringList splitCommand (QStringView command )
bool startDetached (const QString & program , const QStringList & arguments = {}, const QString & workingDirectory = QString(), qint64 * pid = nullptr)
QStringList systemEnvironment ()

保护函数

void setProcessState (QProcess::ProcessState state )

重实现保护函数

virtual qint64 readData (char * data , qint64 maxlen ) override
virtual qint64 writeData (const char * data , qint64 len ) override

详细描述

运行进程

要启动进程,把希望运行的程序名称和命令行自变量作为自变量传递给 start ()。自变量被供给作为个体字符串在 QStringList .

另外,可以设置要运行的程序采用 setProgram () 和 setArguments (),然后调用 start () 或 open ().

例如,以下代码片段通过在自变量列表中传递包含 -style 和 fusion 的字符串在 X11 平台运行 Fusion 风格的指针式时钟范例:

    QObject *parent;
    ...
    QString program = "./path/to/Qt/examples/widgets/analogclock";
    QStringList arguments;
    arguments << "-style" << "fusion";
    QProcess *myProcess = new QProcess(parent);
    myProcess->start(program, arguments);
							

QProcess 然后进入 Starting 状态,和当程序启动时,QProcess 进入 运行 状态并发射 started ().

QProcess 允许把进程视为顺序 I/O 设备。可以读写进程,就像访问网络连接使用 QTcpSocket 。然后可以写入进程标准输入通过调用 write (),和读取标准输出通过调用 read (), readLine (),和 getChar ()。因为它继承 QIODevice ,QProcess 还可以用作输入源对于 QXmlReader ,或对于生成要上传的数据使用 QNetworkAccessManager .

当进程退出时,QProcess 重新进入 NotRunning 状态 (初始状态),并发射 finished ().

finished () 信号以自变量形式提供进程退出代码和退出状态,也可以调用 exitCode () 以获得最后完成进程的退出代码,和 exitStatus () 以获得其退出状态。若在任何时间点发生错误,QProcess 将发射 errorOccurred () 信号。也可以调用 error () 以查找最后发生的错误类型,和 state () 以查找当前进程状态。

注意: QProcess 不支持 VxWorks iOS tvOS 或 watchOS。

凭借通道通信

进程有 2 个预定义输出通道:标准输出通道 ( stdout ) 供给常规控制台输出,和标准错误通道 ( stderr ) 通常提供由进程打印的错误。这些通道表示 2 个单独数据流。可以在它们之间切换通过调用 setReadChannel ()。QProcess 发射 readyRead () 当当前读取通道数据可用时。它还发射 readyReadStandardOutput () 当新标准输出数据可用时,和当新标准错误数据可用时, readyReadStandardError () 被发射。代替调用 read (), readLine (),或 getChar (),可以明确读取 2 通道之一的所有数据通过调用 readAllStandardOutput () 或 readAllStandardError ().

通道术语可能产生误导。注意,进程的输出通道对应于 QProcess 的 read 通道,而进程的输入通道对应于 QProcess 的 write 通道。这是因为我们使用 QProcess 读取的是进程的输出,而写入的变为进程的输入。

QProcess 可以合并 2 输出通道,以便来自运行进程的标准输出和标准错误数据均使用标准输出通道。调用 setProcessChannelMode () 采用 MergedChannels 在开始激活此特征的进程之前。还有将正运行进程输出转发到调用主进程的选项,通过传递 ForwardedChannels 作为自变量。只转发某个输出通道是可能的 - 通常会使用 ForwardedErrorChannel ,但 ForwardedOutputChannel 也存在。注意,在 GUI 应用程序中使用通道转发通常是个坏主意 - 应该以图形呈现错误取而代之。

某些进程需要特殊环境设置才能运转。可以为进程设置环境变量通过调用 setProcessEnvironment ()。要设置工作目录,调用 setWorkingDirectory ()。默认情况下,进程在调用进程的当前工作目录下运行。

属于以 QProcess 启动的 GUI 应用程序的窗口的定位和屏幕 Z 次序,由底层窗口系统控制。对于 Qt 5 应用程序,可以指定定位使用 -qwindowgeometry 命令行选项;X11 应用程序一般接受 -geometry 命令行选项。

注意: 在 QNX,由于操作系统的局限性,设置工作目录可能导致除 QProcess 调用者线程外的所有应用程序线程,在卵生进程期间被临时冻结。

同步进程 API

QProcess 提供允许在没有事件循环的情况下使用的一组函数,通过挂起调用线程直到某些信号被发射为止:

从主线程调用这些函数 (线程调用 QApplication::exec ()) 可能导致用户界面被冻结。

以下范例运行 gzip 以压缩字符串 Qt rocks!,没有事件循环:

    QProcess gzip;
    gzip.start("gzip", QStringList() << "-c");
    if (!gzip.waitForStarted())
        return false;
    gzip.write("Qt rocks!");
    gzip.closeWriteChannel();
    if (!gzip.waitForFinished())
        return false;
    QByteArray result = gzip.readAll();
							

Windows 用户注意事项

某些 Windows 命令 (例如, dir ) 并非由单独应用程序所提供,而是由命令解释器本身所提供。若试图使用 QProcess 直接执行这些命令,它将不工作。一种可能的解决方案是执行命令解释器本身 ( cmd.exe 在某些 Windows 系统),和要求解释器执行期望命令。

另请参阅 QBuffer , QFile ,和 QTcpSocket .

成员类型文档编制

QProcess:: CreateProcessArgumentModifier

注意: 此 typedef 只可用于桌面 Windows。

在 Windows, QProcess 使用 Win32 API 函数 CreateProcess 去启动子级进程。而 QProcess 提供启动进程的舒适方式而无需担心平台细节,在某些情况下调优是可取的将参数传递给 CreateProcess 。这被履行通过定义 CreateProcessArgumentModifier 函数并把它传递给 setCreateProcessArgumentsModifier .

A CreateProcessArgumentModifier 函数接受一参数:指针指向 CreateProcessArguments 结构。此结构的成员会被传递给 CreateProcess 后于 CreateProcessArgumentModifier 函数被调用。

以下范例演示如何把自定义标志传递给 CreateProcess 。当从控制台进程 A 启动控制台进程 B 时, QProcess 默认情况下,进程 B 将重用进程 A 的控制台窗口。在此范例中,将为子级进程 B 创建具有自定义配色方案的新控制台窗口。

    QProcess process;
    process.setCreateProcessArgumentsModifier([] (QProcess::CreateProcessArguments *args)
    {
        args->flags |= CREATE_NEW_CONSOLE;
        args->startupInfo->dwFlags &= ~STARTF_USESTDHANDLES;
        args->startupInfo->dwFlags |= STARTF_USEFILLATTRIBUTE;
        args->startupInfo->dwFillAttribute = BACKGROUND_BLUE | FOREGROUND_RED
                                           | FOREGROUND_INTENSITY;
    });
    process.start("C:\\Windows\\System32\\cmd.exe", QStringList() << "/k" << "title" << "The Child Process");
							

另请参阅 QProcess::CreateProcessArguments and setCreateProcessArgumentsModifier ().

enum QProcess:: ExitStatus

此枚举描述不同退出状态为 QProcess .

常量 描述
QProcess::NormalExit 0 进程正常退出。
QProcess::CrashExit 1 进程崩溃。

另请参阅 exitStatus ().

[since 5.2] enum QProcess:: InputChannelMode

此枚举描述进程输入通道模式为 QProcess 。将这些值之一传递给 setInputChannelMode () 去设置当前写入通道模式。

常量 描述
QProcess::ManagedInputChannel 0 QProcess 管理正运行进程的输入。这是默认输入通道模式为 QProcess .
QProcess::ForwardedInputChannel 1 QProcess 把主进程输入转发给正运行进程。子级进程从主进程的相同源读取其标准输入。注意:主进程不得试着读取其标准输入 (当子级进程正运行时)。

该枚举在 Qt 5.2 引入或被修改。

另请参阅 setInputChannelMode ().

enum QProcess:: ProcessChannel

此枚举描述正运行进程所使用的进程通道。传递这些值之一给 setReadChannel () 设置当前读取通道为 QProcess .

常量 描述
QProcess::StandardOutput 0 正运行进程的 stdout (标准输出)。
QProcess::StandardError 1 正运行进程的 stderr (标准错误)。

另请参阅 setReadChannel ().

enum QProcess:: ProcessChannelMode

此枚举描述进程的输出通道模式为 QProcess 。将这些值之一传递给 setProcessChannelMode () 以设置当前读取通道模式。

常量 描述
QProcess::SeparateChannels 0 QProcess 管理正运行进程的输出,将标准输出和标准错误数据保持在单独内部缓冲中。可以选择 QProcess 的当前读取通道通过调用 setReadChannel ()。这是默认通道模式对于 QProcess .
QProcess::MergedChannels 1 QProcess 将正运行进程的输出合并到标准输出通道 ( stdout )。标准错误通道 ( stderr ) 将不接收任何数据。运行进程的标准输出和标准错误数据是交错的。对于分离进程,正运行进程的合并输出被转发到主进程。
QProcess::ForwardedChannels 2 QProcess 将正运行进程的输出转发到主进程。由子级进程写入其标准输出和标准错误的任何内容,都将写入主进程的标准输出和标准错误。
QProcess::ForwardedErrorChannel 4 QProcess 管理正运行进程的标准输出,但将其标准错误转发到主进程。这反映命令行工具作为过滤器的典型用法,其中标准输出被重定向到另一进程或文件,而标准错误被打印到控制台为诊断目的。(该值在 Qt 5.2 引入。)
QProcess::ForwardedOutputChannel 3 与 ForwardedErrorChannel 互补。(该值在 Qt 5.2 引入。)

注意: Windows 有意抑制从仅 GUI 应用程序输出到继承控制台。 这 not 适用于重定向到文件或管道的输出。尽管如此,要在控制台转发仅 GUI 应用程序的输出,必须使用 SeparateChannels 和通过读取输出并将其写入适当输出通道自己来履行转发。

另请参阅 setProcessChannelMode ().

enum QProcess:: ProcessError

此枚举描述错误的不同类型,报告通过 QProcess .

常量 描述
QProcess::FailedToStart 0 进程启动失败。被援引的程序丢失,或可能没有足够权限 (或资源) 援引程序。
QProcess::Crashed 1 进程有时崩溃在成功启动后。
QProcess::Timedout 2 最后 waitFor...() 函数超时。状态对于 QProcess 不变,和可以再次试着调用 waitFor...()。
QProcess::WriteError 4 发生错误当试图写入进程时。例如,进程可能未运行,或它可能已关闭其输入通道。
QProcess::ReadError 3 发生错误当试图从进程读取时。例如,进程可能未运行。
QProcess::UnknownError 5 发生未知错误。这是默认返回值为 error ().

另请参阅 error ().

enum QProcess:: ProcessState

此枚举描述不同状态为 QProcess .

常量 描述
QProcess::NotRunning 0 进程未运行。
QProcess::Starting 1 进程正在启动,但尚未援引程序。
QProcess::Running 2 进程正在运行且读写就绪。

另请参阅 state ().

成员函数文档编制

QProcess:: QProcess ( QObject * parent = nullptr)

构造 QProcess 对象采用给定 parent .

[signal, since 5.6] void QProcess:: errorOccurred ( QProcess::ProcessError error )

此信号被发射当进程发生错误时。指定 error 描述发生的错误类型。

该函数在 Qt 5.6 引入。

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

此信号被发射当进程完成时。 exitCode 是进程的退出代码 (仅对正常退出有效),和 exitStatus 是退出状态。在进程完成后,缓冲在 QProcess 仍完好无损。仍可以读取进程可能已写入的任何数据在完成之前。

另请参阅 exitStatus ().

[slot] void QProcess:: kill ()

杀除当前进程,导致它立即退出。

在 Windows,kill() 使用 TerminateProcess,而在 Unix 和 macOS,把 SIGKILL 信号发送给进程。

另请参阅 terminate ().

[private signal] void QProcess:: readyReadStandardError ()

此信号被发射当进程已使新数据可用透过其标准错误通道 ( stderr )。它被发射不管当前 读取通道 .

注意: 这是私有信号。它可以用于信号连接,但不能由用户发射。

另请参阅 readAllStandardError () 和 readChannel ().

[private signal] void QProcess:: readyReadStandardOutput ()

此信号被发射当进程已使新数据可用透过其标准输出通道 ( stdout )。它被发射不管当前 读取通道 .

注意: 这是私有信号。它可以用于信号连接,但不能由用户发射。

另请参阅 readAllStandardOutput () 和 readChannel ().

[private signal] void QProcess:: started ()

此信号被发射由 QProcess 当此过程已开始,且 state () 返回 运行 .

注意: 这是私有信号。它可以用于信号连接,但不能由用户发射。

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

此信号被发射每当状态为 QProcess 改变。 newState 自变量为状态 QProcess 要改变。

注意: 这是私有信号。它可以用于信号连接,但不能由用户发射。

[slot] void QProcess:: terminate ()

试图终止进程。

进程可能不会因调用此函数而退出 (它有机会提示用户是否有未保存的文件,等等)。

在 Windows,terminate() 将 WM_CLOSE 消息张贴到进程的所有顶层窗口,然后张贴到进程本身的主线程。在 Unix 和 macOS, SIGTERM 信号被发送。

不运行事件循环的 Windows 控制台应用程序 (或其事件循环不处理 WM_CLOSE 消息),只可被终止通过调用 kill ().

另请参阅 kill ().

[virtual] QProcess:: ~QProcess ()

销毁 QProcess 对象,即:杀除进程。

注意:此函数不会返回直到进程被终止。

[since 5.0] QStringList QProcess:: arguments () const

返回上次启动进程采用的命令行自变量。

该函数在 Qt 5.0 引入。

另请参阅 setArguments () 和 start ().

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

重实现: QIODevice::bytesToWrite () const.

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

返回先前设置的修饰符函数通过调用 setChildProcessModifier ().

注意: 此函数只可用于 Unix 平台。

该函数在 Qt 6.0 引入。

另请参阅 setChildProcessModifier ().

[override virtual] void QProcess:: close ()

重实现: QIODevice::close ().

关闭进程的所有通信并杀除它。在调用此函数后, QProcess 将不再发射 readyRead (),且无法再读取或写入数据。

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

关闭读取通道 channel 。在调用此函数后, QProcess 将不再接收通道数据。任何已收到的数据仍可用于读取。

调用此函数以节省内存,若对进程的输出不感兴趣。

另请参阅 closeWriteChannel () 和 setReadChannel ().

void QProcess:: closeWriteChannel ()

调度写入通道对于 QProcess 要被关闭。一旦所有数据被写入进程,通道就将关闭。在调用此函数后,任何写入进程的试图都将失败。

关闭写入通道是必要的,对于读取输入数据 (直到通道被关闭为止) 的程序而言。例如,程序 more 用于在 Unix 和 Windows 控制台中显示文本数据。但它不会显示文本数据直到 QProcess 的写入通道被关闭。范例:

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

写入通道被隐式打开当 start () 被调用。

另请参阅 closeReadChannel ().

[since 5.7] QProcess::CreateProcessArgumentModifier QProcess:: createProcessArgumentsModifier () const

返回先前设置的 CreateProcess 修饰符函数。

注意: 此函数只可用于 Windows 平台。

该函数在 Qt 5.7 引入。

另请参阅 setCreateProcessArgumentsModifier () 和 QProcess::CreateProcessArgumentModifier .

QProcess::ProcessError QProcess:: error () const

返回最后发生的错误类型。

另请参阅 state ().

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

启动程序 program 采用自变量 arguments 在新进程中,等待它完成,然后返回进程的退出代码。新进程写入控制台的任何数据会被转发给调用进程。

环境和工作目录继承自调用进程。

自变量处理分别等同 start () 重载。

若进程无法启动,返回 -2。若进程崩溃,返回 -1。否则,返回进程的退出代码。

另请参阅 start ().

int QProcess:: exitCode () const

返回最后完成进程的退出代码。

此值无效除非 exitStatus () 返回 NormalExit .

QProcess::ExitStatus QProcess:: exitStatus () const

返回最后完成的进程退出状态。

在 Windows,若进程被另一应用程序的 TerminateProcess() 所终止,此函数仍会返回 NormalExit 除非退出代码小于 0。

[since 5.2] QProcess::InputChannelMode QProcess:: inputChannelMode () const

返回通道模式对于 QProcess 标准输入通道。

该函数在 Qt 5.2 引入。

另请参阅 setInputChannelMode () 和 InputChannelMode .

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

重实现: QIODevice::isSequential () const.

QString QProcess:: nativeArguments () const

返回程序的附加本机命令行自变量。

注意: 此函数只可用于 Windows 平台。

另请参阅 setNativeArguments ().

[static, since 5.2] QString QProcess:: nullDevice ()

操作系统的 null 设备。

返回的文件路径使用本机目录分隔符。

该函数在 Qt 5.2 引入。

另请参阅 QProcess::setStandardInputFile (), QProcess::setStandardOutputFile (),和 QProcess::setStandardErrorFile ().

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

重实现: QIODevice::open (QIODeviceBase::OpenMode mode).

启动程序设置通过 setProgram () 采用自变量设置通过 setArguments ()。OpenMode 被设为 mode .

此方法是别名化的 start (),且存在仅为完全实现定义接口通过 QIODevice .

返回 true 若程序已启动。

另请参阅 start (), setProgram (),和 setArguments ().

QProcess::ProcessChannelMode QProcess:: processChannelMode () const

返回通道模式对于 QProcess 标准输出和标准错误通道。

另请参阅 setProcessChannelMode (), ProcessChannelMode ,和 setReadChannel ().

QProcessEnvironment QProcess:: processEnvironment () const

返回环境 QProcess 将传递给其子级进程,或空对象若没有设置环境使用 setEnvironment() 或 setProcessEnvironment ()。若没有设置环境,将使用调用进程的环境。

另请参阅 setProcessEnvironment (), setEnvironment (),和 QProcessEnvironment::isEmpty ().

[since 5.3] qint64 QProcess:: processId () const

返回正在运行进程的本机进程标识符,若可用。若目前没有进程正在运行, 0 被返回。

该函数在 Qt 5.3 引入。

[since 5.0] QString QProcess:: program () const

返回进程最后一次启动时采用的程序。

该函数在 Qt 5.0 引入。

另请参阅 setProgram () 和 start ().

QByteArray QProcess:: readAllStandardError ()

不管当前读取通道,此函数从进程标准错误返回所有可用数据按 QByteArray .

另请参阅 readyReadStandardError (), readAllStandardOutput (), readChannel (),和 setReadChannel ().

QByteArray QProcess:: readAllStandardOutput ()

不管当前读取通道,此函数从进程标准输出返回所有可用数据按 QByteArray .

另请参阅 readyReadStandardOutput (), readAllStandardError (), readChannel (),和 setReadChannel ().

QProcess::ProcessChannel QProcess:: readChannel () const

返回当前读取通道为 QProcess .

另请参阅 setReadChannel ().

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

重实现: QIODevice::readData (char *data, qint64 maxSize).

[since 5.1] void QProcess:: setArguments (const QStringList & arguments )

设置 arguments 以传递给被调用程序当启动进程时。必须调用此函数先于 start ().

该函数在 Qt 5.1 引入。

另请参阅 start (), setProgram (),和 arguments ().

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

设置 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() 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.

以下展示设置无特权子进程以运行的范例:

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() .

注意: In multithreaded applications, this function must be careful not to call any functions that may lock mutexes that may have been in use in other threads (in general, using only functions defined by POSIX as "async-signal-safe" is advised). Most of the Qt API is unsafe inside this callback, including qDebug (), and may lead to deadlocks.

该函数在 Qt 6.0 引入。

另请参阅 childProcessModifier ().

[since 5.7] void QProcess:: setCreateProcessArgumentsModifier ( QProcess::CreateProcessArgumentModifier modifier )

设置 modifier CreateProcess Win32 API 调用。传递 QProcess::CreateProcessArgumentModifier() 以移除先前设置的。

注意: 此函数只可用于 Windows 平台且要求 C++ 11。

该函数在 Qt 5.7 引入。

另请参阅 createProcessArgumentsModifier (), QProcess::CreateProcessArgumentModifier ,和 setChildProcessModifier ().

[since 5.2] void QProcess:: setInputChannelMode ( QProcess::InputChannelMode mode )

设置通道模式为 QProcess 标准输入通道到 mode 指定。会使用此模式当下次 start () 被调用。

该函数在 Qt 5.2 引入。

另请参阅 inputChannelMode () 和 InputChannelMode .

void QProcess:: setNativeArguments (const QString & arguments )

这是重载函数。

设置额外本机命令行 arguments 为程序。

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.

注意: 此函数只可用于 Windows 平台。

另请参阅 nativeArguments ().

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

设置通道模式为 QProcess 标准输出和标准错误通道到 mode 指定。会使用此模式当下次 start () 被调用。例如:

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();
							

另请参阅 processChannelMode (), ProcessChannelMode ,和 setReadChannel ().

void QProcess:: setProcessEnvironment (const QProcessEnvironment & environment )

设置 environment that QProcess 将传递给子级进程。

例如,以下代码添加环境变量 TMPDIR :

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

注意,在 Windows 环境变量名不区分大小写。

另请参阅 processEnvironment (), QProcessEnvironment::systemEnvironment (),和 setEnvironment ().

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

设置当前状态为 QProcess state 指定。

另请参阅 state ().

[since 5.1] void QProcess:: setProgram (const QString & program )

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

该函数在 Qt 5.1 引入。

另请参阅 start (), setArguments (),和 program ().

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

设置当前读取通道为 QProcess 到给定 channel 。当前输入通道用于函数 read (), readAll (), readLine (),和 getChar ()。它还确定哪个通道触发 QProcess 以发射 readyRead ().

另请参阅 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.

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

Note: if setProcessChannelMode () was called with an argument of QProcess::MergedChannels ,此函数不起作用。

另请参阅 setStandardInputFile (), setStandardOutputFile (),和 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.

另请参阅 setStandardOutputFile (), setStandardErrorFile (),和 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.

另请参阅 setStandardInputFile (), setStandardErrorFile (),和 setStandardOutputProcess ().

void QProcess:: setStandardOutputProcess ( QProcess * destination )

将此进程的标准输出流管道到 destination 进程的标准输入。

以下 Shell 命令:

command1 | command2
							

可以完成采用 QProcess 通过以下代码:

QProcess process1;
QProcess process2;
process1.setStandardOutputProcess(&process2);
process1.start("command1");
process2.start("command2");
							

void QProcess:: setWorkingDirectory (const QString & dir )

把工作目录设为 dir . QProcess 将在此目录下启动进程。默认行为是在调用进程的工作目录下启动进程。

注意: 在 QNX,这可能导致所有应用程序线程被临时冻结。

另请参阅 workingDirectory () 和 start ().

[static, since 5.15] QStringList QProcess:: splitCommand ( QStringView command )

分割字符串 command 成令牌列表,并返回列表。

带空格的令牌可以由双引号环绕;3 连续双引号表示引号字符本身。

该函数在 Qt 5.15 引入。

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

启动给定 program 在新进程中,传递的命令行自变量在 arguments .

QProcess 对象将立即进入 Starting 状态。若进程成功启动, QProcess 将发射 started ();否则, errorOccurred () 会被发射。

注意: 进程是异步启动的,这意味着 started () 和 errorOccurred () 信号可能被延迟。调用 waitForStarted () 以确保进程已启动 (或启动失败) 且这些信号已被发射。

注意: 不履行进一步的自变量分割。

Windows: 自变量加引号并被拼接到兼容命令行采用 CommandLineToArgvW() Windows 函数。对于有不同命令行要求加引号的程序,需要使用 setNativeArguments ()。值得注意的是程序不遵循 CommandLineToArgvW() 规则是 cmd.exe,因此是所有批处理脚本。

OpenMode 被设为 mode .

QProcess 对象已在运行进程,可能在控制台打印警告,且现有进程将不受影响地继续运行。

另请参阅 processId (), started (), waitForStarted (),和 setNativeArguments ().

[since 5.1] void QProcess:: start ( QIODeviceBase::OpenMode mode = ReadWrite)

这是重载函数。

启动程序设置通过 setProgram () 采用自变量设置通过 setArguments ()。OpenMode 被设为 mode .

该函数在 Qt 5.1 引入。

另请参阅 open (), setProgram (),和 setArguments ().

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

启动命令 command 在新进程中。OpenMode 被设为 mode .

command 是包含程序名称及其自变量的单文本字符串。自变量由一个或多个空格分隔。例如:

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

必须引用包含空格的自变量才能被正确提供给新进程。例如:

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

文字引号在 command 字符串由 3 引号表示。例如:

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

之后 command 字符串被拆分和取消引号,此函数的行为像 start ().

在将命令行自变量传递给子进程的本机系统 API 使用单字符串的 Windows 操作系统,可以设想无法传递命令行凭借 QProcess 的基于列表的可移植 API。在这些罕见情况下,需要使用 setProgram () 和 setNativeArguments () 而不是此函数。

该函数在 Qt 6.0 引入。

另请参阅 splitCommand () 和 start ().

[since 5.10] bool QProcess:: startDetached ( qint64 * pid = nullptr)

启动程序设置通过 setProgram () 采用自变量设置通过 setArguments () 在新进程中,并与之分离。返回 true 当成功时;否则返回 false 。若调用进程退出,分离进程将不受影响地继续运行。

Unix: 启动进程将在它自己的会话中运行,且行动像守护程序。

进程将在指定目录下启动设置通过 setWorkingDirectory ()。若 workingDirectory () 为空,工作目录继承自调用进程。

注意: 在 QNX,这可能导致所有应用程序线程被临时冻结。

若函数成功,那么 * pid 被设为启动进程的进程标识符;否则,它被设为 -1。注意,子级进程可能退出,且 PID 可能在没有通知的情况下失效。此外,在子级进程退出后,同一 PID 可能被完全不同进程回收和使用。用户代码应小心当使用此变量时,特别是若某人打算通过操作系统手段强制终止进程。

startDetached() 仅支持以下属性 Setter:

所有其它特性对于 QProcess 对象被忽略。

注意: 被调用进程继承调用进程的控制台窗口。要抑制控制台输出,请将标准/错误输出重定向到 QProcess::nullDevice ().

该函数在 Qt 5.10 引入。

另请参阅 start () 和 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)

此函数重载 startDetached()。

启动程序 program 采用自变量 arguments 在新进程中,并与之分离。返回 true 当成功时;否则返回 false 。若调用进程退出,分离进程将不受影响地继续运行。

自变量处理分别等同 start () 重载。

进程将被启动在目录 workingDirectory 。若 workingDirectory 为空,工作目录继承自调用进程。

若函数成功,那么 * pid 被设为启动进程的进程标识符。

另请参阅 start ().

QProcess::ProcessState QProcess:: state () const

返回进程的当前状态。

另请参阅 stateChanged () 和 error ().

[static] QStringList QProcess:: systemEnvironment ()

以 key=value 对列表形式返回调用进程的环境。范例:

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

此函数不缓存系统环境。因此,获得环境的更新版本是可能的,若低级 C 库函数像 setenv or putenv 有被调用。

不管怎样,注意,重复调用此函数将重新创建环境变量列表 (非通俗操作)。

注意: 对于新代码,推荐使用 QProcessEnvironment::systemEnvironment ()

另请参阅 QProcessEnvironment::systemEnvironment () 和 setProcessEnvironment ().

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

重实现: QIODevice::waitForBytesWritten (int msecs).

bool QProcess:: waitForFinished ( int msecs = 30000)

阻塞直到进程已完成且 finished () 信号已发射,或直到 msecs 毫秒已过去。

返回 true 若进程已完成;否则返回 false (若操作超时,若发生错误,或者若此 QProcess 已完成)。

可以在没有事件循环的情况下操作此函数。它很有用,当编写非 GUI 应用程序和在非 GUI 线程中履行 I/O 操作时。

警告: 从主 GUI 线程调用此函数可能导致用户界面被冻结。

若 msecs 为 -1,此函数不会超时。

另请参阅 finished (), waitForStarted (), waitForReadyRead (),和 waitForBytesWritten ().

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

重实现: QIODevice::waitForReadyRead (int msecs).

bool QProcess:: waitForStarted ( int msecs = 30000)

阻塞直到进程启动且 started () 信号已发射,或直到 msecs 毫秒已过去。

返回 true 若进程成功启动;否则返回 false (若操作超时或发生错误)。

可以在没有事件循环的情况下操作此函数。它很有用,当编写非 GUI 应用程序和在非 GUI 线程中履行 I/O 操作时。

警告: 从主 GUI 线程调用此函数可能导致用户界面被冻结。

若 msecs 为 -1,此函数不会超时。

注意: 在某些 UNIX 操作系统,此函数可能返回 true 但进程可能稍后报告 QProcess::FailedToStart 错误。

另请参阅 started (), waitForReadyRead (), waitForBytesWritten (),和 waitForFinished ().

QString QProcess:: workingDirectory () const

QProcess 已赋值工作目录,此函数返回工作目录 QProcess 将在程序开始之前进入。否则,返回空字符串 (即:没有赋值目录),且 QProcess 将使用应用程序的当前工作目录取而代之。

另请参阅 setWorkingDirectory ().

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

重实现: QIODevice::writeData (const char *data, qint64 maxSize).