FInteractiveProcess

Implements an external process that can be interacted.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FRunnable

FInteractiveProcess

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/InteractiveProcess.h

Include

#include "Misc/InteractiveProcess.h"

Syntax

class FInteractiveProcess : public FRunnable

Remarks

Implements an external process that can be interacted.

Constructors

Name Description

Public function

FInteractiveProcess

(
    const FString& InURL,
    const FString& InParams,
    bool InHidden,
    bool LongTime
)

Creates a new interactive process.

Public function

FInteractiveProcess

(
    const FString& InURL,
    const FString& InParams,
    const FString& InWorkingDir,
    bool InHidden,
    bool LongTime
)

Creates a new interactive process.

Destructors

Name Description

Public function

~FInteractiveProcess()

Destructor.

Functions

Name Description

Public function

void

 

Cancel

(
    bool InKillTree
)

Cancels the process.

Public function Const

FTimespan

 

GetDuration()

Gets the duration of time that the task has been running.

Public function Const

FProcHandle

 

GetProcessHandle()

Gets the Process Handle. The instance can be invalid if the process was not created.

Public function Const

int

 

GetReturnCode()

Returns the return code from the exited process

Public function Const

bool

 

IsRunning()

Checks whether the process is still running.

Public function

bool

 

Launch()

Launches the process

Public function

FSimpleDeleg...

 

OnCanceled()

Returns a delegate that is executed when the process has been canceled.

Public function

FOnInteracti...

 

OnCompleted()

Returns a delegate that is executed when the interactive process completed.

Public function

FOnInteracti...

 

OnOutput()

Returns a delegate that is executed when a interactive process produces output.

Protected function

void

 

ProcessOutput

(
    const FString& Output
)

Processes the given output string.

Protected function

void

 

SendMessageToProcessIf()

Takes the first message to be sent from MessagesToProcess, if there is one, and sends it to process

Public function

void

 

SendWhenReady

(
    const FString& Message
)

Sends the string message when process is ready

Public function

void

 

SendWhenReady

(
    const TArray< uint8 >& Data
)

Sends the data message when process is ready

Overridden from FRunnable

Name Description

Public function Virtual

void

 

Exit()

Exits the runnable object.

Public function Virtual

bool

 

Init()

Initializes the runnable object.

Public function Virtual

uint32

 

Run()

Runs the runnable object.

Public function Virtual

void

 

Stop()

Stops the runnable object.

This is called if a thread is requested to terminate early.