Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FInteractiveProcess

Implements an external process that can be interacted.

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
	FInteractiveProcess ( const FString& InURL, const FString& InParams, bool InHidden, bool LongTime )	Creates a new interactive process.
	FInteractiveProcess ( const FString& InURL, const FString& InParams, const FString& InWorkingDir, bool InHidden, bool LongTime )	Creates a new interactive process.

Destructors

	Name	Description
	~FInteractiveProcess()	Destructor.

Functions

	Name	Description
void	Cancel ( bool InKillTree )	Cancels the process.
FTimespan	GetDuration()	Gets the duration of time that the task has been running.
FProcHandle	GetProcessHandle()	Gets the Process Handle. The instance can be invalid if the process was not created.
int	GetReturnCode()	Returns the return code from the exited process
bool	IsRunning()	Checks whether the process is still running.
bool	Launch()	Launches the process
FSimpleDeleg...	OnCanceled()	Returns a delegate that is executed when the process has been canceled.
FOnInteracti...	OnCompleted()	Returns a delegate that is executed when the interactive process completed.
FOnInteracti...	OnOutput()	Returns a delegate that is executed when a interactive process produces output.
void	ProcessOutput ( const FString& Output )	Processes the given output string.
void	SendMessageToProcessIf()	Takes the first message to be sent from MessagesToProcess, if there is one, and sends it to process
void	SendWhenReady ( const FString& Message )	Sends the string message when process is ready
void	SendWhenReady ( const TArray< uint8 >& Data )	Sends the data message when process is ready

Overridden from FRunnable

	Name	Description
void	Exit()	Exits the runnable object.
bool	Init()	Initializes the runnable object.
uint32	Run()	Runs the runnable object.
void	Stop()	Stops the runnable object. This is called if a thread is requested to terminate early.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss