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

> Unreal Engine API Reference > Runtime > Core > GenericPlatform > FGenericPlatformProcess

Light Theme

Dark Theme

FGenericPlatformProcess

Generic implementation for most platforms, these tend to be unused and unimplemented

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FGenericPlatformProcess

	FHoloLensProcess
	FUnixPlatformProcess

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformProcess.h
Include	#include "GenericPlatform/GenericPlatformProcess.h"

Syntax

struct FGenericPlatformProcess

Remarks

Generic implementation for most platforms, these tend to be unused and unimplemented

Functions

	Name	Description
void	AddDllDirectory ( const TCHAR* Directory )	Adds a directory to search in when resolving implicitly loaded or filename-only DLLs.
const TCHAR ...	ApplicationSettingsDir()	Get application settings directory. Only one return value is valid at a time!
const TCHAR ...	BaseDir()	Get startup directory. Only one return value is valid at a time!
bool	CanLaunchURL ( const TCHAR* URL )	Checks if the platform can launch a uniform resource locator (i.e. http://www.epicgames.com/unreal).
void	CleanShaderWorkingDir()	Clean the shader working directory. Clean the shader working directory
void	ClosePipe ( void* ReadPipe, void* WritePipe )	Closes an anonymous pipe.
void	CloseProc ( FProcHandle& ProcessHandle )	Cleans up FProcHandle after we're done with it.
const TCHAR ...	ComputerName()	Get computer name. Only one return value is valid at a time!
void	ConditionalSleep ( TFunctionRef< bool()> Condition, float SleepTime )	Sleep thread until condition is satisfied.
bool	CreatePipe ( void& ReadPipe, void& WritePipe, bool bWritePipeLocal )	Creates a writable anonymous pipe.
FProcHandle	CreateProc ( const TCHAR* URL, const TCHAR* Parms, bool bLaunchDetached, bool bLaunchHidden, bool bLaunchReallyHidden, uint32* OutProcessID, int32 PriorityModifier, const TCHAR* OptionalWorkingDi..., void* PipeWriteChild, void* PipeReadChild, void* PipeStdErrChild )	Creates a new process and its primary thread, with separate std pipes.
FProcHandle	CreateProc ( const TCHAR* URL, const TCHAR* Parms, bool bLaunchDetached, bool bLaunchHidden, bool bLaunchReallyHidden, uint32* OutProcessID, int32 PriorityModifier, const TCHAR* OptionalWorkingDi..., void* PipeWriteChild, void* PipeReadChild )	Creates a new process and its primary thread.
FRunnableThr...	CreateRunnableThread()	Creates the platform-specific runnable thread.
bool	Daemonize()	Makes process run as a system service (daemon), i.e. detaches it from whatever user session it was initially run from.
bool	DeleteInterprocessSynchObject ( FSemaphore* Object )	Deletes an interprocess synchronization object.
void	DumpThreadInfo ( const TCHAR* MarkerName )	Output information about the currently active thread
bool	ExecElevatedProcess ( const TCHAR* URL, const TCHAR* Params, int32* OutReturnCode )	Executes a process as administrator, requesting elevation as necessary.
bool	ExecProcess ( const TCHAR* URL, const TCHAR* Params, int32* OutReturnCode, FString* OutStdOut, FString* OutStdErr, const TCHAR* OptionalWorkingDi..., bool bShouldEndWithParentProcess )	Executes a process, returning the return code, stdout, and stderr.
const TCHAR ...	ExecutableName ( bool bRemoveExtension )	Return the name of the currently running executable
const TCHAR ...	ExecutablePath()	Return the path to the currently running executable
void	ExploreFolder ( const TCHAR* FilePath )	Attempt to "explore" the folder specified by the provided file path
void	FlushPoolSyncEvents()	Deletes all the recycled sync events contained by the pools
void	FreeDllHandle ( void* DllHandle )	Free a DLL.
FString	GenerateApplicationPath ( const FString& AppName, EBuildConfiguration BuildConfigurat... )	Generates the path to the specified application or game.
bool	GetApplicationMemoryUsage ( uint32 ProcessId, SIZE_T* OutMemoryUsage )	Outputs the virtual memory usage, of the process with the specified PID
FString	GetApplicationName ( uint32 ProcessId )	Returns the Name of process given by the PID. Returns Empty string "" if PID not found.
const TCHAR ...	GetBinariesSubdirectory()	Used only by platforms with DLLs, this gives the subdirectory from binaries to find the executables
uint32	GetCurrentCoreNumber()	Retrieves the current hardware CPU core
uint32	GetCurrentProcessId()	Retrieves the ProcessId of this process.
FString	GetCurrentWorkingDirectory()	Get the current working directory (only really makes sense on desktop platforms)
ENamedThread...	GetDesiredThreadForUObjectReferenceCollector()	Specifies the thread to use for UObject reference collection
void	GetDllDirectories ( TArray< FString >& OutDllDirectori... )	Get the list of registered directories to search in when resolving implicitly loaded or filename-only DLLs.
void *	GetDllExport ( void* DllHandle, const TCHAR* ProcName )	Lookup the address of a DLL function.
void *	GetDllHandle ( const TCHAR* Filename )	Load a DLL.
FString	GetGameBundleId()	Retrieves the platform-specific bundle identifier or package name of the game
const TCHAR ...	GetModuleExtension()	Return the extension of dynamic library
const TCHAR ...	GetModulePrefix()	Return the prefix of dynamic library (e.g. lib)
const FStrin...	GetModulesDirectory()	Used only by platforms with DLLs, this gives the full path to the main directory containing modules
bool	GetProcReturnCode ( FProcHandle& ProcHandle, int32* ReturnCode )	Retrieves the termination status of the specified process.
uint32	GetStackSize()	Get the active stack size for the currently running thread
FEvent *	GetSynchEventFromPool ( bool bIsManualReset )	Gets an event from the pool or creates a new one if necessary.
bool	IsApplicationRunning ( const TCHAR* ProcName )	Returns true if the specified application is running
bool	IsApplicationRunning ( uint32 ProcessId )	Returns true if the specified application is running
bool	IsFirstInstance()	Checks if we're the first instance.
bool	IsProcRunning ( FProcHandle& ProcessHandle )	Returns true if the specified process is running
bool	LaunchFileInDefaultExternalApplication ( const TCHAR* FileName, const TCHAR* Parms, ELaunchVerb::Type Verb, bool bPromptToOpenOnFailure )	Attempt to launch the provided file name in its default external application.
void	LaunchURL ( const TCHAR* URL, const TCHAR* Parms, FString* Error )	Launch a uniform resource locator (i.e. http://www.epicgames.com/unreal).
void	ModifyThreadAssignmentForUObjectReferenceCollector ( int32& NumThreads, int32& NumBackgroundThreads, ENamedThreads::Type& NormalThreadN..., ENamedThreads::Type& BackgroundThr... )	Allows a platform to override the threading configuration for reference collection
FSemaphore &...	NewInterprocessSynchObject ( const TCHAR* Name, bool bCreate, uint32 MaxLocks )	Creates or opens an interprocess synchronization object.
FSemaphore &...	NewInterprocessSynchObject ( const FString& Name, bool bCreate, uint32 MaxLocks )	Creates or opens an interprocess synchronization object.
FProcHandle	OpenProcess ( uint32 ProcessID )	Opens an existing process.
void	PopDllDirectory ( const TCHAR* Directory )	Unsets a directory to look for DLL files.
void	PushDllDirectory ( const TCHAR* Directory )	Set a directory to look for DLL files. NEEDS to have a Pop call when complete
FString	ReadPipe ( void* ReadPipe )	Reads all pending data from an anonymous pipe, such as STDOUT or STDERROR of a process.
bool	ReadPipeToArray ( void* ReadPipe, TArray< uint8 >& Output )	Reads all pending data from an anonymous pipe, such as STDOUT or STDERROR of a process.
void	ReturnSynchEventToPool ( FEvent* Event )	Returns an event to the pool.
void	SetCurrentWorkingDirectoryToBaseDir()
bool	SetProcessLimits ( EProcessResource::Type Resource, uint64 Limit )	Sets the process limits.
void	SetRealTimeMode()	Enables Real Time Mode on the current thread.
void	SetShaderDir ( const TCHAR* Where )
void	SetThreadAffinityMask ( uint64 AffinityMask )	Change the thread processor affinity
void	SetThreadName ( const TCHAR* ThreadName )	Helper function to set thread name of the current thread.
void	SetThreadPriority ( EThreadPriority NewPriority )	Change the thread processor priority
void	SetupAudioThread()	Allow the platform to do anything it needs for audio thread
void	SetupGameThread()	Allow the platform to do anything it needs for game thread
void	SetupRenderThread()	Allow the platform to do anything it needs for render thread
void	SetupRHIThread()	Allow the platform to do anything it needs for the RHI thread
const TCHAR ...	ShaderDir()
const FStrin...	ShaderWorkingDir()	Get the shader working directory. Get the shader working directory
bool	ShouldSaveToUserDir()	Content saved to the game or engine directories should be rerouted to user directories instead
bool	SkipWaitForStats()	Force skip calling FThreadStats::WaitForStats()
void	Sleep ( float Seconds )	Sleep this thread for Seconds.
void	SleepInfinite()	Sleep this thread infinitely.
void	SleepNoStats ( float Seconds )	Sleep this thread for Seconds.
bool	SupportsMultithreading()	Gets whether this platform can use multiple threads.
void	TearDown()	Tears down allocated process resources.
void	TeardownAudioThread()	Allow the platform to tear down the audio thread
void	TerminateProc ( FProcHandle& ProcessHandle, bool KillTree )	Terminates a process
const TCHAR ...	UserDir()	Get user directory. Only one return value is valid at a time!
const TCHAR ...	UserHomeDir()	Get the user home directory. Only one return value is valid at a time!
const TCHAR ...	UserName ( bool bOnlyAlphaNumeric )	Get user name. Only one return value is valid at a time!
const TCHAR ...	UserSettingsDir()	Get the user settings directory. Only one return value is valid at a time!
const TCHAR ...	UserTempDir()	Get the user temporary directory. Only one return value is valid at a time!
EWaitAndFork...	WaitAndFork()	Waits for process signals and forks child processes.
void	WaitForProc ( FProcHandle& ProcessHandle )	Waits for a process to stop
bool	WritePipe ( void* WritePipe, const FString& Message, FString* OutWritten )	Sends the message to process through pipe
bool	WritePipe ( void* WritePipe, const uint8* Data, const int32 DataLength, int32* OutDataLength )	Sends data to process through pipe
void	Yield()	Tells the processor to pause for implementation-specific amount of time.
void	YieldCycles ( uint64 Cycles )	Tells the processor to pause for at least the amount of cycles given.
void	YieldThread()	Yield this thread so another may run for a while.

Classes

	Name	Description
	FSemaphore	Generic representation of a interprocess semaphore

Enums

	Name	Description
	EWaitAndForkResult

Deprecated Functions

		Name	Description
	FEvent *	CreateSynchEvent ( bool bIsManualReset )	Please use GetSynchEventFromPool to create a new event, and ReturnSynchEventToPool to release the event.