FWindowsPlatformMisc Struct Reference

#include <WindowsPlatformMisc.h>

Inheritance diagram for FWindowsPlatformMisc:

Collaboration diagram for FWindowsPlatformMisc:

Public Member Functions
	UE_DEPRECATED (4.21, "void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead.") static void GetEnvironmentVariable(const TCHAR *VariableName
Public Member Functions inherited from FGenericPlatformMisc
	UE_DEPRECATED (4.18, "FPlatformMisc::ClipboardCopy() has been superseded by FPlatformApplicationMisc::ClipboardCopy()") static void ClipboardCopy(const TCHAR *Str)
	UE_DEPRECATED (4.18, "FPlatformMisc::ClipboardPaste() has been superseded by FPlatformApplicationMisc::ClipboardPaste()") static void ClipboardPaste(class FString &Dest)
	UE_DEPRECATED (4.18, "FPaths::SetOverrideGameDir() has been superseded by FPaths::SetOverrideProjectDir().") static FORCEINLINE void SetOverrideGameDir(const FString &InOverrideDir)

Static Public Member Functions
static void	PlatformPreInit ()
static void	PlatformInit ()
static void	PlatformTearDown ()
static void	SetGracefulTerminationHandler ()
static void	CallGracefulTerminationHandler ()
static ECrashHandlingType	GetCrashHandlingType ()
static ECrashHandlingType	SetCrashHandlingType (ECrashHandlingType)
static int32	GetMaxPathLength ()
static FString	GetEnvironmentVariable (const TCHAR *VariableName)
static void	SetEnvironmentVar (const TCHAR *VariableName, const TCHAR *Value)
static TArray< uint8 >	GetMacAddress ()
static void	SubmitErrorReport (const TCHAR *InErrorHist, EErrorReportMode::Type InMode)
static bool	IsDebuggerPresent ()
static EProcessDiagnosticFlags	GetProcessDiagnostics ()
static FORCEINLINE void	MemoryBarrier ()
static bool	IsRemoteSession ()
static void	SetUTF8Output ()
static void	LocalPrint (const TCHAR *Message)
static bool	IsLowLevelOutputDebugStringStructured ()
static bool	IsLocalPrintThreadSafe ()
static void	RequestExitWithStatus (bool Force, uint8 ReturnCode)
static void	RequestExit (bool Force)
static const TCHAR *	GetSystemErrorMessage (TCHAR *OutBuffer, int32 BufferCount, int32 Error)
static void	CreateGuid (struct FGuid &Result)
static EAppReturnType::Type	MessageBoxExt (EAppMsgType::Type MsgType, const TCHAR *Text, const TCHAR *Caption)
static bool	CommandLineCommands ()
static bool	Is64bitOperatingSystem ()
static bool	IsValidAbsolutePathFormat (const FString &Path)
static int32	NumberOfCores ()
static const FProcessorGroupDesc &	GetProcessorGroupDesc ()
static int32	NumberOfCoresIncludingHyperthreads ()
static int32	NumberOfWorkerThreadsToSpawn ()
static const TCHAR *	GetPlatformFeaturesModuleName ()
static FString	GetDefaultLanguage ()
static FString	GetDefaultLocale ()
static uint32	GetLastError ()
static void	SetLastError (uint32 ErrorCode)
static void	RaiseException (uint32 ExceptionCode)
static bool	SetStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName, const FString &InValue)
static bool	GetStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName, FString &OutValue)
static bool	DeleteStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName)
static bool	DeleteStoredSection (const FString &InStoreId, const FString &InSectionName)
static bool	CoInitialize (ECOMModel Model=ECOMModel::Singlethreaded)
static void	CoUninitialize ()
static bool	OsExecute (const TCHAR *CommandType, const TCHAR *Command, const TCHAR *CommandLine=NULL)
static Windows::HWND	GetTopLevelWindowHandle (uint32 ProcessId)
static bool	VerifyWindowsVersion (uint32 MajorVersion, uint32 MinorVersion, uint32 BuildNumber=0)
static void	PromptForRemoteDebugging (bool bIsEnsure)
static bool	HasCPUIDInstruction ()
static bool	HasAVX2InstructionSupport ()
static FString	GetCPUVendor ()
static FString	GetCPUBrand ()
static FString	GetPrimaryGPUBrand ()
static struct FGPUDriverInfo	GetGPUDriverInfo (const FString &DeviceDescription, bool bVerbose=true)
static void	GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)
static FString	GetOSVersion ()
static bool	GetDiskTotalAndFreeSpace (const FString &InPath, uint64 &TotalNumberOfBytes, uint64 &NumberOfFreeBytes)
static bool	GetPageFaultStats (FPageFaultStats &OutStats, EPageFaultFlags Flags=EPageFaultFlags::All)
static bool	GetBlockingIOStats (FProcessIOStats &OutStats, EInputOutputFlags Flags=EInputOutputFlags::All)
static uint32	GetCPUInfo ()
static bool	HasNonoptionalCPUFeatures ()
static bool	NeedsNonoptionalCPUFeaturesCheck ()
static bool	HasTimedPauseCPUFeature ()
static bool	QueryRegKey (const Windows::HKEY InKey, const TCHAR *InSubKey, const TCHAR *InValueName, FString &OutData)
static bool	GetVSComnTools (int32 Version, FString &OutData)
static int32	GetCacheLineSize ()
static const TCHAR *	GetDefaultPathSeparator ()
static FText	GetFileManagerName ()
static bool	HasActiveWiFiConnection ()
static bool	IsRunningOnBattery ()
static FORCEINLINE void	ChooseHDRDeviceAndColorGamut (uint32 DeviceId, uint32 DisplayNitLevel, EDisplayOutputFormat &OutputDevice, EDisplayColorGamut &ColorGamut)
static FString	GetOperatingSystemId ()
static EConvertibleLaptopMode	GetConvertibleLaptopMode ()
static IPlatformChunkInstall *	GetPlatformChunkInstall ()
static void	PumpMessagesOutsideMainLoop ()
static uint64	GetFileVersion (const FString &FileName)
static int32	GetMaxRefreshRate ()
Static Public Member Functions inherited from FGenericPlatformMisc
static void	PlatformPreInit ()
static void	PlatformInit ()
static void	PlatformHandleSplashScreen (bool ShowSplashScreen=false)
static void	PlatformTearDown ()
static void	SetGracefulTerminationHandler ()
static void	SetCrashHandler (void(*CrashHandler)(const FGenericCrashContext &Context))
static ECrashHandlingType	GetCrashHandlingType ()
static ECrashHandlingType	SetCrashHandlingType (ECrashHandlingType Type)
static FString	GetEnvironmentVariable (const TCHAR *VariableName)
static void	SetEnvironmentVar (const TCHAR *VariableName, const TCHAR *Value)
static FORCEINLINE int32	GetMaxPathLength ()
static const TCHAR *	GetPathVarDelimiter ()
static TArray< uint8 >	GetMacAddress ()
static FString	GetMacAddressString ()
static FString	GetHashedMacAddressString ()
static FString	GetDeviceId ()
static FString	GetUniqueAdvertisingId ()
static void	SubmitErrorReport (const TCHAR *InErrorHist, EErrorReportMode::Type InMode)
static bool	IsRemoteSession ()
static FORCEINLINE bool	IsDebuggerPresent ()
static EProcessDiagnosticFlags	GetProcessDiagnostics ()
static FORCEINLINE void	DebugBreak ()
static FString	GetCPUVendor ()
static uint32	GetCPUInfo ()
static bool	HasNonoptionalCPUFeatures ()
static bool	NeedsNonoptionalCPUFeaturesCheck ()
static FString	GetCPUBrand ()
static FString	GetCPUChipset ()
static FString	GetPrimaryGPUBrand ()
static FString	GetDeviceMakeAndModel ()
static struct FGPUDriverInfo	GetGPUDriverInfo (const FString &DeviceDescription)
static void	GetOSVersions (FString &out_OSVersionLabel, FString &out_OSSubVersionLabel)
static FString	GetOSVersion ()
static bool	GetDiskTotalAndFreeSpace (const FString &InPath, uint64 &TotalNumberOfBytes, uint64 &NumberOfFreeBytes)
static bool	GetPageFaultStats (FPageFaultStats &OutStats, EPageFaultFlags Flags=EPageFaultFlags::All)
static bool	GetBlockingIOStats (FProcessIOStats &OutStats, EInputOutputFlags Flags=EInputOutputFlags::All)
static bool	GetContextSwitchStats (FContextSwitchStats &OutStats, EContextSwitchFlags Flags=EContextSwitchFlags::All)
static bool	SupportsMessaging ()
static bool	IsCacheStorageAvailable ()
static bool	SupportsLocalCaching ()
static bool	AllowLocalCaching ()
static bool	SupportsFullCrashDumps ()
static FORCENOINLINE void	MemoryBarrier ()
static void	SetMemoryWarningHandler (void(*Handler)(const FGenericMemoryWarningContext &Context))
static bool	HasMemoryWarningHandler ()
static FORCEINLINE uint32	GetLastError ()
static void	SetLastError (uint32 ErrorCode)
static void	RaiseException (uint32 ExceptionCode)
static void	BeginNamedEvent (const struct FColor &Color, const TCHAR *Text)
static void	BeginNamedEvent (const struct FColor &Color, const ANSICHAR *Text)
template<typename CharType >
static void	StatNamedEvent (const CharType *Text)
static void	TickStatNamedEvents ()
static void	LogNameEventStatsInit ()
static void	EndNamedEvent ()
static void	CustomNamedStat (const TCHAR *Text, float Value, const TCHAR *Graph, const TCHAR *Unit)
static void	CustomNamedStat (const ANSICHAR *Text, float Value, const ANSICHAR *Graph, const ANSICHAR *Unit)
static void	BeginProfilerColor (const struct FColor &Color)
static void	EndProfilerColor ()
static void	BeginEnterBackgroundEvent (const TCHAR *Text)
static void	EndEnterBackgroundEvent ()
static FORCEINLINE void	BeginNamedEventFrame ()
static FORCEINLINE void	InitTaggedStorage (uint32 NumTags)
static FORCEINLINE void	ShutdownTaggedStorage ()
static FORCEINLINE void	TagBuffer (const char *Label, uint32 Category, const void *Buffer, size_t BufferSize)
static bool	SetStoredValues (const FString &InStoreId, const FString &InSectionName, const TMap< FString, FString > &InKeyValues)
static bool	SetStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName, const FString &InValue)
static bool	GetStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName, FString &OutValue)
static bool	DeleteStoredValue (const FString &InStoreId, const FString &InSectionName, const FString &InKeyName)
static bool	DeleteStoredSection (const FString &InStoreId, const FString &InSectionName)
static void	LowLevelOutputDebugString (const TCHAR *Message)
static void VARARGS	LowLevelOutputDebugStringf (const TCHAR *Format,...)
static bool	IsLowLevelOutputDebugStringStructured ()
static void	SetUTF8Output ()
static void	LocalPrint (const TCHAR *Str)
static bool	IsLocalPrintThreadSafe ()
static bool	HasSeparateChannelForDebugOutput ()
static void	RequestExit (bool Force)
static void	RequestExitWithStatus (bool Force, uint8 ReturnCode)
static bool	RestartApplication ()
static bool	RestartApplicationWithCmdLine (const char *CmdLine)
static const TCHAR *	GetSystemErrorMessage (TCHAR *OutBuffer, int32 BufferCount, int32 Error)
static void	CreateGuid (struct FGuid &Result)
static EAppReturnType::Type	MessageBoxExt (EAppMsgType::Type MsgType, const TCHAR *Text, const TCHAR *Caption)
static bool	CommandLineCommands ()
static FORCEINLINE bool	Is64bitOperatingSystem ()
static bool	IsValidAbsolutePathFormat (const FString &Path)
static void	NormalizePath (FString &InPath)
static void	NormalizePath (FStringBuilderBase &InPath)
static const TCHAR *	GetDefaultPathSeparator ()
static bool	UseRenderThread ()
static bool	AllowAudioThread ()
static bool	AllowThreadHeartBeat ()
static int32	NumberOfCores ()
static const FProcessorGroupDesc &	GetProcessorGroupDesc ()
static int32	NumberOfCoresIncludingHyperthreads ()
static int32	NumberOfWorkerThreadsToSpawn ()
static int32	NumberOfIOWorkerThreadsToSpawn ()
static struct FAsyncIOSystemBase *	GetPlatformSpecificAsyncIOSystem ()
static const TCHAR *	GetPlatformFeaturesModuleName ()
static const TCHAR *	RootDir ()
static TArray< FString >	GetAdditionalRootDirectories ()
static void	AddAdditionalRootDirectory (const FString &RootDir)
static const TCHAR *	EngineDir ()
static const TCHAR *	LaunchDir ()
static void	CacheLaunchDir ()
static const TCHAR *	ProjectDir ()
static FString	CloudDir ()
static bool	HasProjectPersistentDownloadDir ()
static bool	CheckPersistentDownloadStorageSpaceAvailable (uint64 BytesRequired, bool bAttemptToUseUI)
static const TCHAR *	GamePersistentDownloadDir ()
static const TCHAR *	GameTemporaryDownloadDir ()
static const TCHAR *	GeneratedConfigDir ()
static const TCHAR *	GetUBTPlatform ()
static const TCHAR *	GetUBTTarget ()
static void	SetUBTTargetName (const TCHAR *InTargetName)
static const TCHAR *	GetUBTTargetName ()
static const TCHAR *	GetNullRHIShaderFormat ()
static IPlatformChunkInstall *	GetPlatformChunkInstall ()
static IPlatformCompression *	GetPlatformCompression ()
static IPlatformHostCommunication &	GetPlatformHostCommunication ()
static bool	OsExecute (const TCHAR *CommandType, const TCHAR *Command, const TCHAR *CommandLine=NULL)
static bool	IsPackagedForDistribution ()
static bool	GetSHA256Signature (const void *Data, uint32 ByteSize, FSHA256Signature &OutSignature)
static FString	GetDefaultLanguage ()
static FString	GetDefaultLocale ()
static FString	GetTimeZoneId ()
static bool	Exec (struct UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Out)
static FText	GetFileManagerName ()
static bool	SupportsMultithreadedFileHandles ()
static void	SetShouldPromptForRemoteDebugging (bool bInShouldPrompt)
static void	SetShouldPromptForRemoteDebugOnEnsure (bool bInShouldPrompt)
static bool	IsEnsureAllowed ()
static void	UpdateHotfixableEnsureSettings ()
static void	TickHotfixables ()
static void	PromptForRemoteDebugging (bool bIsEnsure)
static FORCEINLINE void	Prefetch (const void *Ptr)
static FORCEINLINE void	Prefetch (const void *Ptr, int32 Offset)
static FORCEINLINE void	PrefetchBlock (const void *Ptr)
static FORCEINLINE void	PrefetchBlock (const void *Ptr, int32 NumBytes)
static const TCHAR *	GetDefaultDeviceProfileName ()
static FORCEINLINE int	GetBatteryLevel ()
static FORCEINLINE void	SetBrightness (float bBright)
static FORCEINLINE float	GetBrightness ()
static FORCEINLINE bool	SupportsBrightness ()
static FORCEINLINE bool	IsInLowPowerMode ()
static float	GetDeviceTemperatureLevel ()
static void	SetOverrideProjectDir (const FString &InOverrideDir)
static void	GetValidTargetPlatforms (TArray< FString > &TargetPlatformNames)
static FPlatformUserId	GetPlatformUserForUserIndex (int32 LocalUserIndex)
static int32	GetUserIndexForPlatformUser (FPlatformUserId PlatformUser)
static bool	GetUseVirtualJoysticks ()
static bool	SupportsTouchInput ()
static bool	SupportsForceTouchInput ()
static bool	ShouldDisplayTouchInterfaceOnFakingTouchEvents ()
static bool	DesktopTouchScreen ()
static bool	FullscreenSameAsWindowedFullscreen ()
static bool	GetVolumeButtonsHandledBySystem ()
static void	SetVolumeButtonsHandledBySystem (bool enabled)
static TArray< uint8 >	GetSystemFontBytes ()
static bool	HasActiveWiFiConnection ()
static ENetworkConnectionStatus	GetNetworkConnectionStatus ()
static void	SetNetworkConnectionStatus (ENetworkConnectionStatus NewNetworkConnectionStatus)
static ENetworkConnectionType	GetNetworkConnectionType ()
static bool	HasVariableHardware ()
static bool	HasPlatformFeature (const TCHAR *FeatureName)
static bool	IsRunningOnBattery ()
static EDeviceScreenOrientation	GetDeviceOrientation ()
static void	SetDeviceOrientation (EDeviceScreenOrientation NewDeviceOrientation)
static EDeviceScreenOrientation	GetAllowedDeviceOrientation ()
static void	SetAllowedDeviceOrientation (EDeviceScreenOrientation NewAllowedDeviceOrientation)
static int32	GetDeviceVolume ()
static FGuid	GetMachineId ()
static FString	GetLoginId ()
static FString	GetEpicAccountId ()
static FString	GetOperatingSystemId ()
static EConvertibleLaptopMode	GetConvertibleLaptopMode ()
static const TCHAR *	GetEngineMode ()
static TArray< FString >	GetPreferredLanguages ()
static FString	GetLocalCurrencyCode ()
static FString	GetLocalCurrencySymbol ()
static void	RegisterForRemoteNotifications ()
static bool	IsRegisteredForRemoteNotifications ()
static void	UnregisterForRemoteNotifications ()
static bool	ShouldDisablePluginAtRuntime (const FString &PluginName)
static void	PrepareMobileHaptics (EMobileHapticsType Type)
static void	TriggerMobileHaptics ()
static void	ReleaseMobileHaptics ()
static void	ShareURL (const FString &URL, const FText &Description, int32 LocationHintX, int32 LocationHintY)
static bool	SupportsDeviceCheckToken ()
static bool	RequestDeviceCheckToken (TFunction< void(const TArray< uint8 > &)> QuerySucceededFunc, TFunction< void(const FString &, const FString &)> QueryFailedFunc)
static TArray< FCustomChunk >	GetOnDemandChunksForPakchunkIndices (const TArray< int32 > &PakchunkIndices)
static TArray< FCustomChunk >	GetAllOnDemandChunks ()
static TArray< FCustomChunk >	GetAllLanguageChunks ()
static TArray< FCustomChunk >	GetCustomChunksByType (ECustomChunkType DesiredChunkType)
static FString	LoadTextFileFromPlatformPackage (const FString &RelativePath)
static bool	FileExistsInPlatformPackage (const FString &RelativePath)
static void	TearDown ()
static void	ParseChunkIdPakchunkIndexMapping (TArray< FString > ChunkIndexRedirects, TMap< int32, int32 > &OutMapping)
static void	PumpMessagesOutsideMainLoop ()
static void	PumpMessagesForSlowTask ()
static void	PumpEssentialAppMessages ()
static void	HidePlatformStartupScreen ()
static FORCEINLINE bool	UseHDRByDefault ()
static FORCEINLINE void	ChooseHDRDeviceAndColorGamut (uint32 DeviceId, uint32 DisplayNitLevel, EDisplayOutputFormat &OutputDevice, EDisplayColorGamut &ColorGamut)
static FORCEINLINE int32	GetChunkIDFromPakchunkIndex (int32 PakchunkIndex)
static int32	GetPakchunkIndexFromPakFile (const FString &InFilename)
static FORCEINLINE bool	Expand16BitIndicesTo32BitOnLoad ()
static FORCEINLINE void	GetNetworkFileCustomData (TMap< FString, FString > &OutCustomPlatformData)
static FORCEINLINE bool	SupportsBackbufferSampling ()
static int32	GetMaxRefreshRate ()
static int32	GetMaxSupportedRefreshRate ()
static int32	GetMaxSyncInterval ()
static bool	IsPGOEnabled ()
static void	ShowConsoleWindow ()
static int	GetMobilePropagateAlphaSetting ()
static bool	IsRunningInCloud ()
static void	DisableScreenTimeout ()
static void	EnableScreenTimeout ()
static bool	SetupSyscallFilters ()
static bool	GetPlatformScreenWarnings (TArray< FText > &PlatformScreenWarnings)

Public Attributes
TCHAR *	Result
TCHAR int32	ResultLength

Additional Inherited Members
Static Protected Member Functions inherited from FGenericPlatformMisc
static void	GetConfiguredCoreLimits (int32 PlatformNumPhysicalCores, int32 PlatformNumLogicalCores, bool &bOutFullyInitialized, int32 &OutPhysicalCoreLimit, int32 &OutLogicalCoreLimit, bool &bOutSetPhysicalCountToLogicalCount)
Static Protected Attributes inherited from FGenericPlatformMisc
static bool	bShouldPromptForRemoteDebugging
static bool	bPromptForRemoteDebugOnEnsure
static EDeviceScreenOrientation	AllowedDeviceOrientation
static ENetworkConnectionStatus	CurrentNetworkConnectionStatus

Detailed Description

Windows implementation of the misc OS functions

Definition at line 44 of file WindowsPlatformMisc.h.

Member Function Documentation

CallGracefulTerminationHandler()

static void FWindowsPlatformMisc::CallGracefulTerminationHandler ( )

static

ChooseHDRDeviceAndColorGamut()

static FORCEINLINE void FWindowsPlatformMisc::ChooseHDRDeviceAndColorGamut ( uint32 DeviceId, uint32 DisplayNitLevel, EDisplayOutputFormat & OutputDevice, EDisplayColorGamut & ColorGamut )

inlinestatic

Definition at line 262 of file WindowsPlatformMisc.h.

CoInitialize()

static bool FWindowsPlatformMisc::CoInitialize ( ECOMModel Model = ECOMModel::Singlethreaded )

static

CommandLineCommands()

static bool FWindowsPlatformMisc::CommandLineCommands ( )

static

CoUninitialize()

static void FWindowsPlatformMisc::CoUninitialize ( )

static

CreateGuid()

static void FWindowsPlatformMisc::CreateGuid ( struct FGuid & Result )

static

DeleteStoredSection()

static bool FWindowsPlatformMisc::DeleteStoredSection ( const FString & InStoreId, const FString & InSectionName )

static

DeleteStoredValue()

static bool FWindowsPlatformMisc::DeleteStoredValue ( const FString & InStoreId, const FString & InSectionName, const FString & InKeyName )

static

GetBlockingIOStats()

static bool FWindowsPlatformMisc::GetBlockingIOStats ( FProcessIOStats & OutStats, EInputOutputFlags Flags = EInputOutputFlags::All )

static

GetCacheLineSize()

static int32 FWindowsPlatformMisc::GetCacheLineSize ( )

static

GetConvertibleLaptopMode()

static EConvertibleLaptopMode FWindowsPlatformMisc::GetConvertibleLaptopMode ( )

static

GetCPUBrand()

static FString FWindowsPlatformMisc::GetCPUBrand ( )

static

GetCPUInfo()

static uint32 FWindowsPlatformMisc::GetCPUInfo ( )

static

Uses cpuid instruction to get the vendor string

Returns

CPU info bitfield

    Bits 0-3    Stepping ID
    Bits 4-7    Model
    Bits 8-11   Family
    Bits 12-13  Processor type (Intel) / Reserved (AMD)
    Bits 14-15  Reserved
    Bits 16-19  Extended model
    Bits 20-27  Extended family
    Bits 28-31  Reserved

GetCPUVendor()

static FString FWindowsPlatformMisc::GetCPUVendor ( )

static

GetCrashHandlingType()

static ECrashHandlingType FWindowsPlatformMisc::GetCrashHandlingType ( )

static

GetDefaultLanguage()

static FString FWindowsPlatformMisc::GetDefaultLanguage ( )

static

GetDefaultLocale()

static FString FWindowsPlatformMisc::GetDefaultLocale ( )

static

GetDefaultPathSeparator()

static const TCHAR * FWindowsPlatformMisc::GetDefaultPathSeparator ( )

static

Returns

Windows path separator.

GetDiskTotalAndFreeSpace()

static bool FWindowsPlatformMisc::GetDiskTotalAndFreeSpace ( const FString & InPath, uint64 & TotalNumberOfBytes, uint64 & NumberOfFreeBytes )

static

GetEnvironmentVariable()

static FString FWindowsPlatformMisc::GetEnvironmentVariable ( const TCHAR * VariableName )

static

GetFileManagerName()

static FText FWindowsPlatformMisc::GetFileManagerName ( )

static

Returns

Get the name of the platform specific file manager (Explorer)

GetFileVersion()

static uint64 FWindowsPlatformMisc::GetFileVersion ( const FString & FileName )

static

GetGPUDriverInfo()

static struct FGPUDriverInfo FWindowsPlatformMisc::GetGPUDriverInfo ( const FString & DeviceDescription, bool bVerbose = true )

static

GetLastError()

static uint32 FWindowsPlatformMisc::GetLastError ( )

static

GetMacAddress()

static TArray< uint8 > FWindowsPlatformMisc::GetMacAddress ( )

static

GetMaxPathLength()

static int32 FWindowsPlatformMisc::GetMaxPathLength ( )

static

GetMaxRefreshRate()

static int32 FWindowsPlatformMisc::GetMaxRefreshRate ( )

static

GetOperatingSystemId()

static FString FWindowsPlatformMisc::GetOperatingSystemId ( )

static

Gets a globally unique ID the represents a particular operating system install.

GetOSVersion()

static FString FWindowsPlatformMisc::GetOSVersion ( )

static

GetOSVersions()

static void FWindowsPlatformMisc::GetOSVersions ( FString & out_OSVersionLabel, FString & out_OSSubVersionLabel )

static

GetPageFaultStats()

static bool FWindowsPlatformMisc::GetPageFaultStats ( FPageFaultStats & OutStats, EPageFaultFlags Flags = EPageFaultFlags::All )

static

GetPlatformChunkInstall()

static IPlatformChunkInstall * FWindowsPlatformMisc::GetPlatformChunkInstall ( )

static

GetPlatformFeaturesModuleName()

static const TCHAR * FWindowsPlatformMisc::GetPlatformFeaturesModuleName ( )

static

GetPrimaryGPUBrand()

static FString FWindowsPlatformMisc::GetPrimaryGPUBrand ( )

static

GetProcessDiagnostics()

static EProcessDiagnosticFlags FWindowsPlatformMisc::GetProcessDiagnostics ( )

static

GetProcessorGroupDesc()

static const FProcessorGroupDesc & FWindowsPlatformMisc::GetProcessorGroupDesc ( )

static

GetStoredValue()

static bool FWindowsPlatformMisc::GetStoredValue ( const FString & InStoreId, const FString & InSectionName, const FString & InKeyName, FString & OutValue )

static

GetSystemErrorMessage()

static const TCHAR * FWindowsPlatformMisc::GetSystemErrorMessage ( TCHAR * OutBuffer, int32 BufferCount, int32 Error )

static

GetTopLevelWindowHandle()

static Windows::HWND FWindowsPlatformMisc::GetTopLevelWindowHandle ( uint32 ProcessId )

static

Attempts to get the handle to a top-level window of the specified process.

If the process has a single main window (root), its handle will be returned. If the process has multiple top-level windows, the first one found is returned.

Parameters

ProcessId

The identifier of the process to get the window for.

Returns

Window handle, or 0 if not found.

GetVSComnTools()

static bool FWindowsPlatformMisc::GetVSComnTools ( int32 Version, FString & OutData )

static

Gets Visual Studio common tools path.

Parameters

Version	Version of VS to get (11 - 2012, 12 - 2013).
OutData	Output parameter with common tools path.

Returns

Returns if succeeded.

HasActiveWiFiConnection()

static bool FWindowsPlatformMisc::HasActiveWiFiConnection ( )

inlinestatic

Returns whether WiFi connection is currently active

Definition at line 251 of file WindowsPlatformMisc.h.

HasAVX2InstructionSupport()

static bool FWindowsPlatformMisc::HasAVX2InstructionSupport ( )

static

Determines if AVX2 instruction set is supported on this platform

Returns

Returns true if instruction-set is supported

HasCPUIDInstruction()

static bool FWindowsPlatformMisc::HasCPUIDInstruction ( )

static

Determines if the cpuid instruction is supported on this processor

Returns

Returns true if cpuid is supported

HasNonoptionalCPUFeatures()

static bool FWindowsPlatformMisc::HasNonoptionalCPUFeatures ( )

static

Returns

whether this cpu supports certain required instructions or not

HasTimedPauseCPUFeature()

static bool FWindowsPlatformMisc::HasTimedPauseCPUFeature ( )

static

Returns

whether this cpu has timed pause instruction support or not

Is64bitOperatingSystem()

static bool FWindowsPlatformMisc::Is64bitOperatingSystem ( )

static

IsDebuggerPresent()

static bool FWindowsPlatformMisc::IsDebuggerPresent ( )

static

IsLocalPrintThreadSafe()

static bool FWindowsPlatformMisc::IsLocalPrintThreadSafe ( )

inlinestatic

Definition at line 95 of file WindowsPlatformMisc.h.

Here is the call graph for this function:

IsLowLevelOutputDebugStringStructured()

static bool FWindowsPlatformMisc::IsLowLevelOutputDebugStringStructured ( )

static

IsRemoteSession()

static bool FWindowsPlatformMisc::IsRemoteSession ( )

static

IsRunningOnBattery()

static bool FWindowsPlatformMisc::IsRunningOnBattery ( )

static

Returns whether the platform is running on battery power or not.

IsValidAbsolutePathFormat()

static bool FWindowsPlatformMisc::IsValidAbsolutePathFormat ( const FString & Path )

static

LocalPrint()

static void FWindowsPlatformMisc::LocalPrint ( const TCHAR * Message )

static

MemoryBarrier()

static FORCEINLINE void FWindowsPlatformMisc::MemoryBarrier ( )

inlinestatic

Definition at line 79 of file WindowsPlatformMisc.h.

MessageBoxExt()

static EAppReturnType::Type FWindowsPlatformMisc::MessageBoxExt ( EAppMsgType::Type MsgType, const TCHAR * Text, const TCHAR * Caption )

static

NeedsNonoptionalCPUFeaturesCheck()

static bool FWindowsPlatformMisc::NeedsNonoptionalCPUFeaturesCheck ( )

static

Returns

whether to check for specific CPU compatibility or not

NumberOfCores()

static int32 FWindowsPlatformMisc::NumberOfCores ( )

static

NumberOfCoresIncludingHyperthreads()

static int32 FWindowsPlatformMisc::NumberOfCoresIncludingHyperthreads ( )

static

NumberOfWorkerThreadsToSpawn()

static int32 FWindowsPlatformMisc::NumberOfWorkerThreadsToSpawn ( )

static

OsExecute()

static bool FWindowsPlatformMisc::OsExecute ( const TCHAR * CommandType, const TCHAR * Command, const TCHAR * CommandLine = NULL )

static

Has the OS execute a command and path pair (such as launch a browser)

Parameters

ComandType	OS hint as to the type of command
Command	the command to execute
CommandLine	the commands to pass to the executable

Returns

whether the command was successful or not

PlatformInit()

static void FWindowsPlatformMisc::PlatformInit ( )

static

PlatformPreInit()

static void FWindowsPlatformMisc::PlatformPreInit ( )

static

PlatformTearDown()

static void FWindowsPlatformMisc::PlatformTearDown ( )

static

PromptForRemoteDebugging()

static void FWindowsPlatformMisc::PromptForRemoteDebugging ( bool bIsEnsure )

static

PumpMessagesOutsideMainLoop()

static void FWindowsPlatformMisc::PumpMessagesOutsideMainLoop ( )

static

QueryRegKey()

static bool FWindowsPlatformMisc::QueryRegKey ( const Windows::HKEY InKey, const TCHAR * InSubKey, const TCHAR * InValueName, FString & OutData )

static

Provides a simpler interface for fetching and cleanup of registry value queries

Parameters

InKey	The Key (folder) in the registry to search under
InSubKey	The Sub Key (folder) within the main Key to look for
InValueName	The Name of the Value (file) withing the Sub Key to look for
OutData	The Data entered into the Value

Returns

true, if it successfully found the Value

RaiseException()

static void FWindowsPlatformMisc::RaiseException ( uint32 ExceptionCode )

static

RequestExit()

static void FWindowsPlatformMisc::RequestExit ( bool Force )

static

RequestExitWithStatus()

static void FWindowsPlatformMisc::RequestExitWithStatus ( bool Force, uint8 ReturnCode )

static

SetCrashHandlingType()

static ECrashHandlingType FWindowsPlatformMisc::SetCrashHandlingType ( ECrashHandlingType )

static

SetEnvironmentVar()

static void FWindowsPlatformMisc::SetEnvironmentVar ( const TCHAR * VariableName, const TCHAR * Value )

static

SetGracefulTerminationHandler()

static void FWindowsPlatformMisc::SetGracefulTerminationHandler ( )

static

SetLastError()

static void FWindowsPlatformMisc::SetLastError ( uint32 ErrorCode )

static

SetStoredValue()

static bool FWindowsPlatformMisc::SetStoredValue ( const FString & InStoreId, const FString & InSectionName, const FString & InKeyName, const FString & InValue )

static

SetUTF8Output()

static void FWindowsPlatformMisc::SetUTF8Output ( )

static

SubmitErrorReport()

static void FWindowsPlatformMisc::SubmitErrorReport ( const TCHAR * InErrorHist, EErrorReportMode::Type InMode )

static

UE_DEPRECATED()

FWindowsPlatformMisc::UE_DEPRECATED	(	4.	21,
		"void FPlatformMisc::GetEnvironmentVariable(Name, Result, Length) is deprecated. Use FString FPlatformMisc::GetEnvironmentVariable(Name) instead."	) const

VerifyWindowsVersion()

static bool FWindowsPlatformMisc::VerifyWindowsVersion ( uint32 MajorVersion, uint32 MinorVersion, uint32 BuildNumber = 0 )

static

Determines if we are running on the Windows version or newer

See the 'Remarks' section of https://msdn.microsoft.com/en-us/library/windows/desktop/ms724833(v=vs.85).aspx for a list of MajorVersion/MinorVersion version combinations for Microsoft Windows.

Returns

Returns true if the current Windows version if equal or newer than MajorVersion

Member Data Documentation

Result

TCHAR* FWindowsPlatformMisc::Result

Definition at line 57 of file WindowsPlatformMisc.h.

ResultLength

TCHAR int32 FWindowsPlatformMisc::ResultLength

Definition at line 57 of file WindowsPlatformMisc.h.

---

The documentation for this struct was generated from the following file:

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Windows/WindowsPlatformMisc.h