1. Epic GamesDeveloper
  3. FInteractiveProcess

FInteractiveProcess

Implements an external process that can be interacted.

Unreal Engine C++ API Reference > Runtime > Core > Misc

Inheritance Hierarchy

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

  Type 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

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function void

Cancel ( bool InKillTree
)

 Cancels the process.
Public function Const FTimespan Gets the duration of time that the task has been running.
Public function Const FProcHandle Gets the Process Handle. The instance can be invalid if the process was not created.
Public function Const int Returns the return code from the exited process
Public function Const bool Checks whether the process is still running.
Public function bool

Launch ()

 Launches the process
Public function FSimpleDelegate & Returns a delegate that is executed when the process has been canceled.
Public function FOnInteractiveProcessCompleted & Returns a delegate that is executed when the interactive process completed.
Public function FOnInteractiveProcessOutput & 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 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

  Type 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page