FGenericPlatformProcess

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

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/GenericPlatform

Inheritance Hierarchy

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

  Type Name Description
Public function Static void

AddDllDirectory ( const TCHAR* Directory
)

 Adds a directory to search in when resolving implicitly loaded or filename-only DLLs.
Public function Static const TCHAR * Get application settings directory. NOTE: Only one return value is valid at a time!
Public function Static const TCHAR *

BaseDir ()

 Get startup directory. NOTE: Only one return value is valid at a time!
Public function Static bool

CanLaunchURL ( const TCHAR* URL
)

 Checks if the platform can launch a uniform resource locator (i.e. http://www.epicgames.com/unreal).
Public function Static void Clean the shader working directory.Clean the shader working directory
Public function Static void

ClosePipe ( void* ReadPipe,
void* WritePipe
)

 Closes an anonymous pipe.
Public function Static void

CloseProc ( FProcHandle& ProcessHandle
)

 Cleans up FProcHandle after we're done with it.
Public function Static const TCHAR * Get computer name. NOTE: Only one return value is valid at a time!
Public function Static void

ConditionalSleep ( TFunctionRef< bool()> Condition,
float SleepTime
)

 Sleep thread until condition is satisfied.
Public function Static bool

CreatePipe ( void*& ReadPipe,
void*& WritePipe,
bool bWritePipeLocal
)

 Creates a writable anonymous pipe.
Public function Static FProcHandle

CreateProc ( const TCHAR* URL,
const TCHAR* Parms,
bool bLaunchDetached,
bool bLaunchHidden,
bool bLaunchReallyHidden,
uint32* OutProcessID,
int32 PriorityModifier,
const TCHAR* OptionalWorkingDirectory,
void* PipeWriteChild,
void* PipeReadChild,
void* PipeStdErrChild
)

 Creates a new process and its primary thread, with separate std pipes.
Public function Static FProcHandle

CreateProc ( const TCHAR* URL,
const TCHAR* Parms,
bool bLaunchDetached,
bool bLaunchHidden,
bool bLaunchReallyHidden,
uint32* OutProcessID,
int32 PriorityModifier,
const TCHAR* OptionalWorkingDirectory,
void* PipeWriteChild,
void* PipeReadChild
)

 Creates a new process and its primary thread.
Public function Static FRunnableThread * Creates the platform-specific runnable thread.
Public function Static FEvent *

CreateSynchEvent ( bool bIsManualReset
)

 Creates a new event.
Public function Static bool Makes process run as a system service (daemon), i.e. detaches it from whatever user session it was initially run from.
Public function Static bool Deletes an interprocess synchronization object.
Public function Static void

DumpThreadInfo ( const TCHAR* MarkerName
)

 Output information about the currently active thread
Public function Static bool

ExecElevatedProcess ( const TCHAR* URL,
const TCHAR* Params,
int32* OutReturnCode
)

 Executes a process as administrator, requesting elevation as necessary.
Public function Static bool

ExecProcess ( const TCHAR* URL,
const TCHAR* Params,
int32* OutReturnCode,
FString* OutStdOut,
FString* OutStdErr,
const TCHAR* OptionalWorkingDirectory,
bool bShouldEndWithParentProcess
)

 Executes a process, returning the return code, stdout, and stderr.
Public function Static const TCHAR *

ExecutableName ( bool bRemoveExtension
)

 Return the name of the currently running executable
Public function Static const TCHAR * Return the path to the currently running executable
Public function Static void

ExploreFolder ( const TCHAR* FilePath
)

 Attempt to "explore" the folder specified by the provided file path
Public function Static void Deletes all the recycled sync events contained by the pools
Public function Static void

FreeDllHandle ( void* DllHandle
)

 Free a DLL.
Public function Static FString

GenerateApplicationPath ( const FString& AppName,
EBuildConfiguration BuildConfiguration
)

 Generates the path to the specified application or game.
Public function Static bool

GetApplicationMemoryUsage ( uint32 ProcessId,
SIZE_T* OutMemoryUsage
)

 Outputs the virtual memory usage, of the process with the specified PID
Public function Static FString

GetApplicationName ( uint32 ProcessId
)

 Returns the Name of process given by the PID. Returns Empty string "" if PID not found.
Public function Static FString Get application settings directory for a given context.
Public function Static const TCHAR * Used only by platforms with DLLs, this gives the subdirectory from binaries to find the executables
Public function Static uint32 Retrieves the current hardware CPU core
Public function Static uint32 Retrieves the ProcessId of this process.
Public function Static FString Get the current working directory (only really makes sense on desktop platforms)
Public function Static ENamedThreads::Type Specifies the thread to use for UObject reference collection
Public function Static void

GetDllDirectories ( TArray< FString >& OutDllDirectories
)

 Get the list of registered directories to search in when resolving implicitly loaded or filename-only DLLs.
Public function Static void *

GetDllExport ( void* DllHandle,
const TCHAR* ProcName
)

 Lookup the address of a DLL function.
Public function Static void *

GetDllHandle ( const TCHAR* Filename
)

 Load a DLL.
Public function Static FString Retrieves the platform-specific bundle identifier or package name of the game
Public function Static const TCHAR * Return the extension of dynamic library
Public function Static const TCHAR * Return the prefix of dynamic library (e.g. lib)
Public function Static const FString Used only by platforms with DLLs, this gives the full path to the main directory containing modules
Public function Static bool

GetProcReturnCode ( FProcHandle& ProcHandle,
int32* ReturnCode
)

 Retrieves the termination status of the specified process.
Public function Static uint32 Get the active stack size for the currently running thread
Public function Static FEvent *

GetSynchEventFromPool ( bool bIsManualReset
)

 Gets an event from the pool or creates a new one if necessary.
Public function Static bool

IsApplicationRunning ( const TCHAR* ProcName
)

 Returns true if the specified application is running
Public function Static bool Returns true if the specified application is running
Public function Static bool Checks if we're the first instance.
Public function Static bool

IsProcRunning ( FProcHandle& ProcessHandle
)

 Returns true if the specified process is running
Public function Static 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.
Public function Static void

LaunchURL ( const TCHAR* URL,
const TCHAR* Parms,
FString* Error
)

 Launch a uniform resource locator (i.e. http://www.epicgames.com/unreal).
Public function Static bool

LaunchURLFiltered ( const TCHAR* URL,
const TCHAR* Parms,
FString* Error,
const UE::Core::FURLRequestFilter& Filter
)

 Launch a uniform resource locator (i.e. http://www.epicgames.com/unreal).
Public function Static void

ModifyThreadAssignmentForUObjectReferenceCollector ( int32& NumThreads,
int32& NumBackgroundThreads,
ENamedThreads::Type& NormalThreadName,
ENamedThreads::Type& BackgroundThreadName
)

 Allows a platform to override the threading configuration for reference collection
Public function Static FSemaphore *

NewInterprocessSynchObject ( const TCHAR* Name,
bool bCreate,
uint32 MaxLocks
)

 Creates or opens an interprocess synchronization object.
Public function Static FSemaphore *

NewInterprocessSynchObject ( const FString& Name,
bool bCreate,
uint32 MaxLocks
)

 Creates or opens an interprocess synchronization object.
Public function Static FProcHandle

OpenProcess ( uint32 ProcessID
)

 Opens an existing process.
Public function Static void

PopDllDirectory ( const TCHAR* Directory
)

 Unsets a directory to look for DLL files.
Public function Static void

PushDllDirectory ( const TCHAR* Directory
)

 Set a directory to look for DLL files. NEEDS to have a Pop call when complete
Public function Static FString

ReadPipe ( void* ReadPipe
)

 Reads all pending data from an anonymous pipe, such as STDOUT or STDERROR of a process.
Public function Static bool

ReadPipeToArray ( void* ReadPipe,
TArray< uint8 >& Output
)

 Reads all pending data from an anonymous pipe, such as STDOUT or STDERROR of a process.
Public function Static void Returns an event to the pool.
Public function Static void  
Public function Static bool Sets the process limits.
Public function Static void Enables Real Time Mode on the current thread.
Public function Static void

SetShaderDir ( const TCHAR* Where
)

  
Public function Static void

SetThreadAffinityMask ( uint64 AffinityMask
)

 Change the thread processor affinity
Public function Static void

SetThreadName ( const TCHAR* ThreadName
)

 Helper function to set thread name of the current thread.
Public function Static void Change the thread processor priority
Public function Static void Allow the platform to do anything it needs for audio thread
Public function Static void Allow the platform to do anything it needs for game thread
Public function Static void Allow the platform to do anything it needs for render thread
Public function Static void Allow the platform to do anything it needs for the RHI thread
Public function Static const TCHAR *  
Public function Static const FString Get the shader working directory.Get the shader working directory
Public function Static bool Content saved to the game or engine directories should be rerouted to user directories instead
Public function Static bool Force skip calling FThreadStats::WaitForStats()
Public function Static void

Sleep ( float Seconds
)

 Sleep this thread for Seconds.
Public function Static void Sleep this thread infinitely.
Public function Static void

SleepNoStats ( float Seconds
)

 Sleep this thread for Seconds.
Public function Static bool Gets whether this platform can use multiple threads.
Public function Static void Tears down allocated process resources.
Public function Static void Allow the platform to tear down the audio thread
Public function Static void

TerminateProc ( FProcHandle& ProcessHandle,
bool KillTree
)

 Terminates a process
Public function Static void

TerminateProcTreeWithPredicate ( FProcHandle& ProcessHandle,
TFunctionRef< bool(uint32 ProcessId, const TCHAR*ApplicationName)> Predicate
)

 Terminates a process tree
Public function Static bool Queries the memory usage of the process. Returns whether the operation is supported and succeeded.
Public function Static const TCHAR *

UserDir ()

 Get user directory. NOTE: Only one return value is valid at a time!
Public function Static const TCHAR * Get the user home directory. NOTE: Only one return value is valid at a time!
Public function Static const TCHAR *

UserName ( bool bOnlyAlphaNumeric
)

 Get user name. NOTE: Only one return value is valid at a time!
Public function Static const TCHAR * Get the user settings directory. NOTE: Only one return value is valid at a time!
Public function Static const TCHAR * Get the user temporary directory. NOTE: Only one return value is valid at a time!
Public function Static EWaitAndForkResult Waits for process signals and forks child processes.
Public function Static void

WaitForProc ( FProcHandle& ProcessHandle
)

 Waits for a process to stop
Public function Static bool

WritePipe ( void* WritePipe,
const FString& Message,
FString* OutWritten
)

 Sends the message to process through pipe
Public function Static bool

WritePipe ( void* WritePipe,
const uint8* Data,
const int32 DataLength,
int32* OutDataLength
)

 Sends data to process through pipe
Public function Static void

Yield ()

 Tells the processor to pause for implementation-specific amount of time.
Public function Static void

YieldCycles ( uint64 Cycles
)

 Tells the processor to pause for at least the amount of cycles given.
Public function Static void Yield this thread so another may run for a while.

Classes

  Type Name Description
Public struct ApplicationSettingsContext    
Public struct FSemaphore Generic representation of a interprocess semaphore  

Enums

  Type Name Description
Public enum EWaitAndForkResult    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page