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 > Unix > FUnixPlatformMisc

Light Theme

Dark Theme

FUnixPlatformMisc

Unix implementation of the misc OS functions

Windows

MacOS

Linux

Inheritance Hierarchy

FGenericPlatformMisc

FUnixPlatformMisc

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Unix/UnixPlatformMisc.h
Include	#include "Unix/UnixPlatformMisc.h"

Syntax

struct FUnixPlatformMisc : public FGenericPlatformMisc

Remarks

Unix implementation of the misc OS functions

Functions

	Name	Description
void	CreateGuid ( FGuid& Result )
FString	GetCPUBrand()
uint32	GetCPUInfo()	Uses cpuid instruction to get the vendor string
FString	GetCPUVendor()
bool	GetDiskTotalAndFreeSpace ( const FString& InPath, uint64& TotalNumberOfBytes, uint64& NumberOfFreeBytes )
FString	GetEnvironmentVariable ( const TCHAR* VariableName )
FString	GetLoginId()
TArray< uint...	GetMacAddress()
int32	GetMaxPathLength()
const TCHAR ...	GetNullRHIShaderFormat()	Determines the shader format for the platform
FString	GetOperatingSystemId()
FString	GetOSVersion()
const TCHAR ...	GetPathVarDelimiter()
IPlatformChu...	GetPlatformChunkInstall()
const TCHAR ...	GetSystemErrorMessage ( TCHAR* OutBuffer, int32 BufferCount, int32 Error )
bool	HasBeenStartedRemotely()	Returns whether the program has been started remotely (e.g. over SSH)
bool	HasCPUIDInstruction()
bool	HasNonoptionalCPUFeatures()
bool	HasOverriddenReturnCode ( uint8* OverriddenReturnCodeToU... )	Determines if return code has been overriden and returns it.
bool	IsDebuggerPresent()
bool	IsRunningOnBattery()
void	LowLevelOutputDebugString ( const TCHAR* Message )
void	MemoryBarrier()
EAppReturnTy...	MessageBoxExt ( EAppMsgType::Type MsgType, const TCHAR* Text, const TCHAR* Caption )
bool	NeedsNonoptionalCPUFeaturesCheck()
void	NormalizePath ( FString& InPath )
int32	NumberOfCores()
int32	NumberOfCoresIncludingHyperthreads()
void	PlatformInit()
void	PlatformTearDown()
void	Prefetch ( void const* Ptr, int32 Offset )
void	PrefetchBlock ( const void* InPtr, int32 NumBytes )
void	RequestExit ( bool Force )
void	RequestExitWithStatus ( bool Force, uint8 ReturnCode )
void	SetCrashHandler ( void... )
void	SetEnvironmentVar ( const TCHAR* VariableName, const TCHAR* Value )
void	SetGracefulTerminationHandler()
bool	SetStoredValues ( const FString& InStoreId, const FString& InSectionName, const TMap< FString, FString >& In... )
void	UngrabAllInput()	Ungrabs input (useful before breaking into debugging)

Deprecated Functions

		Name	Description
	void	GetEnvironmentVariable ( const TCHAR* VariableName, TCHAR* Result, int32 ResultLength )	void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead.

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

Take our survey

Dismiss