code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strcat ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestCount, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src )


module: Core

code: static const WIDECHAR * Strchr ( const WIDECHAR * String, WIDECHAR C )


code: static const ANSICHAR * Strchr ( const ANSICHAR * String, ANSICHAR C )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strchr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) C )


code: static int32 Strcmp ( const WIDECHAR * String1, const WIDECHAR * String2 )


code: static int32 Strcmp ( const ANSICHAR * String1, const ANSICHAR * String2 )


code: static int32 Strcmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2 )


description: Wide character implementation

code: static WIDECHAR * Strcpy ( WIDECHAR * Dest, SIZE_T DestCount, const WIDECHAR * Src )


description: Ansi implementation

code: static ANSICHAR * Strcpy ( ANSICHAR * Dest, SIZE_T DestCount, const ANSICHAR * Src )


description: UTF8CHAR implementation.

code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strcpy ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestCount, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src )


code: static int32 Strlen ( const WIDECHAR * String )


code: static int32 Strlen ( const ANSICHAR * String )


description: UCS2CHAR implementation - this is identical to WIDECHAR for Windows platforms

code: static int32 Strlen ( const UCS2CHAR * String )


code: static int32 Strlen ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 Strncmp ( const WIDECHAR * String1, const WIDECHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const ANSICHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


code: static WIDECHAR * Strncpy ( WIDECHAR * Dest, const WIDECHAR * Src, SIZE_T MaxLen )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strncpy ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src, SIZE_T MaxLen )


code: static int32 Strnlen ( const WIDECHAR * String, SIZE_T StringSize )


code: static int32 Strnlen ( const ANSICHAR * String, SIZE_T StringSize )


code: static int32 Strnlen ( const UCS2CHAR * String, SIZE_T StringSize )


code: static int32 Strnlen ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, SIZE_T StringSize )


code: static ANSICHAR * Strncpy ( ANSICHAR * Dest, const ANSICHAR * Src, SIZE_T MaxLen )


code: static const WIDECHAR * Strrchr ( const WIDECHAR * String, WIDECHAR C )


code: static const ANSICHAR * Strrchr ( const ANSICHAR * String, ANSICHAR C )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strrchr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) C )


code: static const WIDECHAR * Strstr ( const WIDECHAR * String, const WIDECHAR * Find )


code: static const ANSICHAR * Strstr ( const ANSICHAR * String, const ANSICHAR * Find )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strstr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Find )


code: static int32 Strtoi ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static int32 Strtoi ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static int32 Strtoi ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: static int64 Strtoi64 ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static int64 Strtoi64 ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static int64 Strtoi64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: static WIDECHAR * Strtok ( WIDECHAR * StrToken, const WIDECHAR * Delim, WIDECHAR ** Context )


code: static ANSICHAR * Strtok ( ANSICHAR * StrToken, const ANSICHAR * Delim, ANSICHAR ** Context )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strtok ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * StrToken, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Delim, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** Context )


code: static uint64 Strtoui64 ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static uint64 Strtoui64 ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static uint64 Strtoui64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


className: FMicrosoftPlatformString

description: Microsoft specific implementation

code: struct FMicrosoftPlatformString : public [FGenericWidePlatformString](API\Runtime\Core\GenericPlatform\FGenericWidePlatformString)


description: Like Parse but it doesn't alter the pointer

code: void GetValue ( const TCHAR * In )


description: Could be optimized but doesn't have to be fast

code: bool operator== ( const [FMultiInt](API\Runtime\Core\GenericPlatform\FMultiInt)< TSize > & rhs ) const


description: The base comparison operator, we derive the others from it

code: bool operator> ( const [FMultiInt](API\Runtime\Core\GenericPlatform\FMultiInt)< TSize > & rhs ) const


code: bool operator>= ( const [FMultiInt](API\Runtime\Core\GenericPlatform\FMultiInt)< TSize > & rhs ) const


code: bool operator< ( const [FMultiInt](API\Runtime\Core\GenericPlatform\FMultiInt)< TSize > & rhs ) const


code: bool operator<= ( const [FMultiInt](API\Runtime\Core\GenericPlatform\FMultiInt)< TSize > & rhs ) const


code: bool operator!= ( const [FMultiInt](API\Runtime\Core\GenericPlatform\FMultiInt)< TSize > & rhs ) const


className: Size

code: static constexpr uint32 Size = TSize;


description: Constructor

code: FMultiInt()


className: FPageFaultStats

description: Different types of Page Fault stats

code: struct FPageFaultStats

HardPageFaults

description: Page faults for data on disk (platform dependent)

SoftPageFaults

description: Page faults for data already in memory (platform dependent)

TotalPageFaults

description: All page fault types


className: FMultiInt

description: TSize integer values separated by '.' e.g. "120.210.11.22" made to compare different GPU driver versions handles whitespace if there are to too many numbers we take the left most ones comparison operators (for driver comparison)

code: template<int32 TSize> class FMultiInt

Value

description: [0]:left .. [Size-1]:right


code: FPlatformHostCommunicationAutoInit()


code: ~FPlatformHostCommunicationAutoInit()


className: FPlatformHostCommunicationAutoInit

description: Helper RAII type for auto initializing instances derived fromIPlatformHostCommunication.

code: template<typename T> struct FPlatformHostCommunicationAutoInit

HostCommunication

type: T


className: FProcessIOStats

description: Different types of Input/Output stats

code: struct FProcessIOStats

BlockingInput

description: Blocking Input operations

BlockingOther

description: Blocking operations that were neither Input or Output operations (platform dependent)

BlockingOutput

description: Blocking Output operations

InputBytes

description: Input bytes transferred

OtherBytes

description: Bytes transferred that were not from either Input or Output operations

OutputBytes

description: Output bytes transferred


className: MaxNumProcessorGroups

code: static constexpr uint16 MaxNumProcessorGroups = 16;


className: FProcessorGroupDesc

code: struct FProcessorGroupDesc


description: Length of the string used to store the symbol's names, including the trailing character.

code: enum { MAX_NAME_LENGTH = 1024 }


description: Default constructor.

code: FProgramCounterSymbolInfo()


className: FProgramCounterSymbolInfo

description: Symbol information associated with a program counter. ANSI version.

code: struct FProgramCounterSymbolInfo

Filename

description: Filename.

FunctionName

description: Function name.

LineNumber

description: Line number in file.

ModuleName

description: Module name.

OffsetInModule

description: Program counter offset into module.

ProgramCounter

description: Program counter.

SymbolDisplacement

description: Symbol displacement of address.


className: FProgramCounterSymbolInfoEx

code: struct FProgramCounterSymbolInfoEx

Filename

type: FString

description: Filename.

FunctionName

description: Function name.

LineNumber

description: Line number in file.

ModuleName

description: Module name.

OffsetInModule

description: Program counter offset into module.

ProgramCounter

description: Program counter.

description: Symbol displacement of address.


description: Default constructor.

code: FProgramCounterSymbolInfoEx ( [FString](API\Runtime\Core\Containers\FString) InModuleName, [FString](API\Runtime\Core\Containers\FString) InFunctionName, [FString](API\Runtime\Core\Containers\FString) InFilename, uint32 InLineNumber, uint64 InSymbolDisplacement, uint64 InOffsetInModule, uint64 InProgramCounter )


className: FPtrInfo

description: Describes a pointer.

code: struct FPtrInfo

Padding

description: Explicit padding for 32 bit builds

Ptr

type: uint8 *

description: Address of the allocation.

Size

description: Size of the allocation.


className: FSessionContext

description: Fixed size structure that holds session specific state.

code: struct FSessionContext

bIsExitRequested

type: bool

MemoryStats

type: FPlatformMemory...


description: Generates a hex string of the signature


description: Holds a computed SHA256 hash.

code: struct FSHA256Signature


className: FSharedCrashContext

description: Fixed size struct holds crash information and session specific state. It is designed to shared between processes (e.g. Game and CrashReporterClient).

code: struct FSharedCrashContext

CrashFilesDirectory

description: Directory for dumped files.

CrashType

type: ECrashContextTy...

DynamicData

description: Fixed size dynamic buffer.

EnabledPluginsNum

description: Count and offset into dynamic buffer to comma separated plugin list.

EngineDataNum

description: Count and offset into dynamic buffer to comma separated key=value data for engine information.

ErrorMessage

description: Exception info.

ErrorProgramCounter

type: void *

description: Program counter address where the error occurred.

ExceptionProgramCounter

description: Instruction address where the exception was raised that initiated crash reporting.

GameDataNum

description: Count and offset into dynamic buffer to comma separated key=value data for game information.

PlatformCrashContext

description: Platform specific crash context (must be portable)

SessionContext

type: FSessionContext

description: Game/Engine information not possible to catch out of process.

UserSettings

type: FUserSettingsCo...

description: Additional user settings.


code: static double Atod ( const WIDECHAR * String )


className: FStackWalkModuleInfo

description: This is used to capture all of the module information needed to load pdb's.

code: struct FStackWalkModuleInfo

type: unsigned long

type: unsigned short

type: unsigned char[8...

type: FStackWalkModul...


code: static double Atod ( const ANSICHAR * String )


code: static double Atod ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static float Atof ( const WIDECHAR * String )


code: static float Atof ( const ANSICHAR * String )


code: static float Atof ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 Atoi ( const WIDECHAR * String )


code: static int32 Atoi ( const ANSICHAR * String )


code: static int32 Atoi ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int64 Atoi64 ( const WIDECHAR * String )


code: static int64 Atoi64 ( const ANSICHAR * String )


code: static int64 Atoi64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static int32 GetVarArgs ( ANSICHAR * Dest, SIZE_T DestSize, const ANSICHAR *& Fmt, va_list ArgPtr )


code: static int32 GetVarArgs ( WIDECHAR * Dest, SIZE_T DestSize, const WIDECHAR *& Fmt, va_list ArgPtr )


code: static int32 GetVarArgs ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestSize, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) *& Fmt, va_list ArgPtr )


code: static WIDECHAR * Strcat ( WIDECHAR * Dest, SIZE_T DestCount, const WIDECHAR * Src )


code: static ANSICHAR * Strcat ( ANSICHAR * Dest, SIZE_T DestCount, const ANSICHAR * Src )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strcat ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestCount, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src )


code: static const WIDECHAR * Strchr ( const WIDECHAR * String, WIDECHAR C )


code: static const ANSICHAR * Strchr ( const ANSICHAR * String, ANSICHAR C )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strchr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) C )


code: static int32 Strcmp ( const WIDECHAR * String1, const WIDECHAR * String2 )


code: static int32 Strcmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2 )


code: static int32 Strcmp ( const ANSICHAR * String1, const ANSICHAR * String2 )


description: Unicode implementation

code: static WIDECHAR * Strcpy ( WIDECHAR * Dest, SIZE_T DestCount, const WIDECHAR * Src )


description: Ansi implementation

code: static ANSICHAR * Strcpy ( ANSICHAR * Dest, SIZE_T DestCount, const ANSICHAR * Src )


code: static int32 Strlen ( const ANSICHAR * String )


code: static int32 Strlen ( const WIDECHAR * String )


code: static int32 Strlen ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


description: UTF8CHAR implementation.

code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strcpy ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, SIZE_T DestCount, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src )


description: UCS2 implementation

code: static int32 Strlen ( const UCS2CHAR * String )


code: static int32 Strncmp ( const WIDECHAR * String1, const WIDECHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const ANSICHAR * String1, const ANSICHAR * String2, SIZE_T Count )


code: static int32 Strncmp ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String1, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String2, SIZE_T Count )


code: static ANSICHAR * Strncpy ( ANSICHAR * Dest, const ANSICHAR * Src, SIZE_T MaxLen )


code: static WIDECHAR * Strncpy ( WIDECHAR * Dest, const WIDECHAR * Src, SIZE_T MaxLen )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strncpy ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Dest, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Src, SIZE_T MaxLen )


code: static int32 Strnlen ( const WIDECHAR * String, SIZE_T StringSize )


code: static int32 Strnlen ( const ANSICHAR * String, SIZE_T StringSize )


code: static int32 Strnlen ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, SIZE_T StringSize )


code: static const WIDECHAR * Strrchr ( const WIDECHAR * String, WIDECHAR C )


code: static const ANSICHAR * Strrchr ( const ANSICHAR * String, ANSICHAR C )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strrchr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) C )


code: static const WIDECHAR * Strstr ( const WIDECHAR * String, const WIDECHAR * Find )


code: static const ANSICHAR * Strstr ( const ANSICHAR * String, const ANSICHAR * Find )


code: static const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strstr ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Find )


code: static int32 Strnlen ( const UCS2CHAR * String, SIZE_T StringSize )


code: static int32 Strtoi ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static int32 Strtoi ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: static int64 Strtoi64 ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static int64 Strtoi64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: static int64 Strtoi64 ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static WIDECHAR * Strtok ( WIDECHAR * StrToken, const WIDECHAR * Delim, WIDECHAR ** Context )


code: static int32 Strtoi ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Strtok ( [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * StrToken, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Delim, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** Context )


code: static ANSICHAR * Strtok ( ANSICHAR * StrToken, const ANSICHAR * Delim, ANSICHAR ** Context )


code: static uint64 Strtoui64 ( const ANSICHAR * Start, ANSICHAR ** End, int32 Base )


code: static uint64 Strtoui64 ( const WIDECHAR * Start, WIDECHAR ** End, int32 Base )


code: static uint64 Strtoui64 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Start, [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) ** End, int32 Base )


code: template<typename CharType> static CharType * Strupr ( CharType * Dest, SIZE_T DestCount )


className: FStandardPlatformString

description: Standard implementation

code: struct FStandardPlatformString : public [FGenericPlatformString](API\Runtime\Core\GenericPlatform\FGenericPlatformString)


description: Releases system-wide critical section if it is currently owned

code: void Release()


code: FSystemWideCriticalSectionNotImplemented &40; const FSystemWideCriticalSectionNotImplemented & &41;


description: Construct a named, system-wide critical section and attempt to get access/ownership of it

code: FSystemWideCriticalSectionNotImplemented ( const [FString](API\Runtime\Core\Containers\FString) & Name, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timeout )


description: Destructor releases system-wide critical section if it is currently owned


description: Platforms that don't need a working FSystemWideCriticalSection can just typedef this one


className: FThreadStackFrames

description: Portable thread stack frame

code: struct FThreadStackFrames

StackFrames

type: TArray<FCrashS...


description:
Does the calling thread have ownership of the system-wide critical section?
True if the system-wide lock is obtained.

code: bool IsValid() const


className: FUserSettingsContext

description: Additional user settings to be communicated to crash reporting client.

code: struct FUserSettingsContext


description:
Flushes file handle to disk.
true if operation completed successfully.

code: bool Flush ( const bool bFullFlush )


description:
Read bytes from the file.
true if the operation completed successfully.

code: bool Read ( uint8 * Destination, int64 BytesToRead )


description:
Change the current write or read position.
true if the operation completed successfully.

code: bool Seek ( int64 NewPosition )


description:
Change the current write or read position, relative to the end of the file.
true if the operation completed successfully.

code: bool SeekFromEnd ( int64 NewPositionRelativeToEnd )


description: Minimizes optional system or process cache kept for the file.

code: virtual void ShrinkBuffers()


description: Return the total size of the file

code: virtual int64 Size()


description: Return the current write or read position.

code: int64 Tell()


description:
Write bytes to the file.
true if the operation completed successfully.

code: bool Write ( const uint8 * Source, int64 BytesToWrite )


description:
Truncate the file to the given size (in bytes).
true if the operation completed successfully.

code: bool Truncate ( int64 NewSize )


className: IFileHandle

description: File handle interface.

code: class IFileHandle


description: Destructor, also the only way to close the file handle

code: virtual ~IFileHandle()


code: const [FString](API\Runtime\Core\Containers\FString) & PakGetMountPoint() const


description: Return whether the Pak has an entry for the given FileName. Not necessarily exclusive; other Patch Paks may have their own copy of the same File.

code: bool PakContains ( const [FString](API\Runtime\Core\Containers\FString) & Filename ) const


code: const [FString](API\Runtime\Core\Containers\FString) & PakGetPakFilename() const


description: Calls the given Visitor on every FileName in the Pruned DirectoryIndex. FileNames passed to the Vistory are the RelativePath from the Mount of the PakFile The Pruned DirectoryIndexat Runtime contains only the DirectoryIndexKeepFiles-specified subset of FilesNames and DirectoryNames that exist in the PakFile

code: void PakVisitPrunedFilenames ( [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor ) const


className: IPakFile

description: Interface class forFPakFileto allow usage from modules that cannot have a compile dependency onFPakFile

code: class IPakFile


description: Gets the platform file wrapped by this file.

code: virtual [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * GetLowerLevel()


description: Gets this platform file type name.

code: virtual const TCHAR * GetName() const


description:
Initializes platform file.
true if the initialization was successful, false otherise.

code: virtual bool Initialize ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine )


description: Sets the platform file wrapped by this file.

code: virtual void SetLowerLevel ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * NewLowerLevel )


description: Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

code: virtual bool ShouldBeUsed ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine ) const


className: IPhysicalPlatformFile

description: Common base for physical platform File I/O Interface

code: class IPhysicalPlatformFile : public [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile)


description:
Request a delegate callback on chunk install completion or failure. Request may not be respected.
Handle to the bound delegate

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddChunkInstallDelegate ( FPlatformChunkInstallDelegate Delegate )


description:
Request a delegate callback on named chunk install completion or failure. Request may not be respected.
Handle to the bound delegate

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddNamedChunkInstallDelegate ( FPlatformNamedChunkInstallDelegate Delegate )


description:
For platforms that support emulation of the Chunk install. Starts transfer of the next chunk. Does nothing in a shipping build.
true if the operation succeeds.

code: bool DebugStartNextChunk()


description: Allow an external system to notify that a particular chunk ID has become available Initial use-case is for dynamically encrypted pak files to signal to the outside world that it has become available.

code: void ExternalNotifyChunkAvailable ( uint32 InChunkID )


description:
Get the current location of a chunk. Pakchunk index and platform chunk id are not always the same. Call GetPakchunkLocation instead of calling from outside.
Enum specifying whether the chunk is available to use, waiting to install, or does not exist.

code: [EChunkLocation::Type](API\Runtime\Core\GenericPlatform\EChunkLocation__Type) GetChunkLocation ( uint32 ChunkID )


description:
Get the current install progress of a chunk. Let the user specify report type for platforms that support more than one.
A value whose meaning is dependent on the ReportType param.

code: float GetChunkProgress ( uint32 ChunkID, [EChunkProgressReportingType::Type](API\Runtime\Core\GenericPlatform\EChunkProgressReportingType__Typ-) ReportType )


description: Deprecated* Call GetNamedChunksByType instead

code: [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > GetCustomChunksByType ( ECustomChunkType DesiredChunkType )


description:
Inquire about the priority of chunk installation vs. game IO.
Paused, low or high priority.


description:
Get the current location of the given named chunk
Enum specifying whether the chunk is available to use, waiting to install, or does not exist.

code: [EChunkLocation::Type](API\Runtime\Core\GenericPlatform\EChunkLocation__Type) GetNamedChunkLocation ( const [FName](API\Runtime\Core\UObject\FName) NamedChunk )


description:
Get the current install progress of the given named chunk. Let the user specify report type for platforms that support more than one.
A value whose meaning is dependent on the ReportType param.

code: float GetNamedChunkProgress ( const [FName](API\Runtime\Core\UObject\FName) NamedChunk, [EChunkProgressReportingType::Type](API\Runtime\Core\GenericPlatform\EChunkProgressReportingType__Typ-) ReportType )


description:
Get a list of all the named chunks of the given type
Array containing all named chunks of the given type

code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetNamedChunksByType ( ENamedChunkType NamedChunkType ) const


description:
Query the type of the given named chunk
Enum indicating the type of chunk, if any

code: ENamedChunkType GetNamedChunkType ( const [FName](API\Runtime\Core\UObject\FName) NamedChunk ) const


description:
Get the current location of a chunk with pakchunk index.
Enum specifying whether the chunk is available to use, waiting to install, or does not exist.

code: [EChunkLocation::Type](API\Runtime\Core\GenericPlatform\EChunkLocation__Type) GetPakchunkLocation ( int32 PakchunkIndex )


description:
Check if a given reporting type is supported.
true if reporting type is supported on the current platform.

code: bool GetProgressReportingTypeSupported ( [EChunkProgressReportingType::Type](API\Runtime\Core\GenericPlatform\EChunkProgressReportingType__Typ-) ReportType )


description: Deprecated* Call InstallNamedChunks instead

code: bool InstallChunks ( const [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > & ChunkTagsID )


description:
Install the given named chunk
whether installation task has been kicked

code: bool InstallNamedChunk ( const [FName](API\Runtime\Core\UObject\FName) NamedChunk )


description:
Install the given set of named chunks
whether installation task has been kicked

code: bool InstallNamedChunks ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > & NamedChunks )


description: Deprecated* Call IsNamedChunkInProgress instead

code: bool IsChunkInstallationPending ( const [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > & ChunkTagsID )


description:
Check whether the give chunk is being installed
whether installation task has been kicked

code: bool IsNamedChunkInProgress ( const [FName](API\Runtime\Core\UObject\FName) NamedChunk )


description:
Hint to the installer that we would like to prioritize a specific chunk
false if the operation is not allowed or the chunk doesn't exist, otherwise true.

code: bool PrioritizeChunk ( uint32 ChunkID, [EChunkPriority::Type](API\Runtime\Core\GenericPlatform\EChunkPriority__Type) Priority )


code: bool PrioritizeNamedChunk ( const [FName](API\Runtime\Core\UObject\FName) NamedChunk, [EChunkPriority::Type](API\Runtime\Core\GenericPlatform\EChunkPriority__Type) Priority )


code: bool PrioritizePakchunk ( int32 PakchunkIndex, [EChunkPriority::Type](API\Runtime\Core\GenericPlatform\EChunkPriority__Type) Priority )


description: Remove a delegate callback on chunk install completion.

code: void RemoveChunkInstallDelegate ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Delegate )


description: Remove a delegate callback on named chunk install completion.

code: void RemoveNamedChunkInstallDelegate ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Delegate )


description:
Specify the priority of chunk installation vs. game IO.
false if the operation is not allowed, otherwise true.

code: bool SetInstallSpeed ( [EChunkInstallSpeed::Type](API\Runtime\Core\GenericPlatform\EChunkInstallSpeed__Type) InstallSpeed )


description: Deprecated* Call SupportsNamedChunkInstall instead

code: bool SupportsIntelligentInstall()


description:
Check whether current platform supports chunk installation by name
whether Intelligent Install is supported

code: bool SupportsNamedChunkInstall() const


description: Deprecated* Call UninstallNamedChunks instead

code: bool UninstallChunks ( const [TArray](API\Runtime\Core\Containers\TArray)< [FCustomChunk](API\Runtime\Core\GenericPlatform\FCustomChunk) > & ChunkTagsID )


description:
Uninstall the given named chunk
whether uninstallation task has been kicked

code: bool UninstallNamedChunk ( const [FName](API\Runtime\Core\UObject\FName) NamedChunk )


description:
Uninstall the given set of named chunks
whether uninstallation task has been kicked

code: bool UninstallNamedChunks ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > & NamedChunks )


description: Virtual destructor

code: virtual ~IPlatformChunkInstall()


className: IPlatformChunkInstall

description: Interface for platform specific chunk based install

code: class IPlatformChunkInstall


className: IPlatformChunkInstallModule

description: Platform Chunk Install Module Interface

code: class IPlatformChunkInstallModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Identifies any platform specific paths that are guaranteed to be local (i.e. cache, scratch space)

code: virtual void AddLocalDirectories ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & LocalDirectories )


description:
Converts passed in filename to use an absolute path (for reading).
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )


description:
Converts passed in filename to use an absolute path (for writing)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )


code: virtual void BypassSecurity ( bool bInBypass )


description:
Copy a file or a hierarchy of files (directory).
true if operation completed successfully.

code: virtual bool CopyDirectoryTree ( const TCHAR * DestinationDirectory, const TCHAR * Source, bool bOverwriteAllExisting )


description:
Copy a file. This will fail if the destination file already exists.
true if the file was copied sucessfully.

code: virtual bool CopyFile ( const TCHAR * To, const TCHAR * From, EPlatformFileRead ReadFlags, EPlatformFileWrite WriteFlags )


description: Create a directory and return true if the directory was created or already existed.

code: bool CreateDirectory ( const TCHAR * Directory )


description: Create a directory, including any parent directories and return true if the directory was created or already existed.

code: virtual bool CreateDirectoryTree ( const TCHAR * Directory )


description:
Delete all files and subdirectories in a directory, then delete the directory itself
true if the directory was deleted or did not exist.

code: virtual bool DeleteDirectoryRecursively ( const TCHAR * Directory )


description: Delete a directory and return true if the directory was deleted or otherwise does not exist.

code: bool DeleteDirectory ( const TCHAR * Directory )


description: Delete a file and return true if the file exists. Will not delete read only files.

code: bool DeleteFile ( const TCHAR * Filename )


description: Return true if the directory exists.

code: bool DirectoryExists ( const TCHAR * Directory )


description:
Checks to see if this file system creates publicly accessible files
true if this file system creates publicly accessible files

code: virtual bool DoesCreatePublicFiles()


description:
Callback for a single file or a directory in a directory iteration.
true if the iteration should continue.

code: bool Visit &40; const TCHAR &42; FilenameOrDirectory, const FFileStatData & StatData &41;


className: FDirectoryStatVisitor

description: Base class for file and directory visitors that take all the stat data.

code: class FDirectoryStatVisitor


className: FDirectoryStatVisitorFunc

description: File and directory visitor function that takes all the stat data

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const TCHAR *, const [FFileStatData](API\Runtime\Core\GenericPlatform\FFileStatData) &)> FDirectoryStatVisitorFunc


description: True if the Visit function can be called from multiple threads at once.

code: bool IsThreadSafe&40;&41; const


code: bool Visit &40; const TCHAR &42; FilenameOrDirectory, bool bIsDirectory &41;


code: FDirectoryVisitor &40; EDirectoryVisitorFlags InDirectoryVisitorFlags &41;


code: virtual &126;FDirectoryVisitor&40;&41;


className: FDirectoryVisitor

description: Base class for file and directory visitors that take only the name.

code: class FDirectoryVisitor

DirectoryVisitorFlags

type: EDirectoryVisit...


className: FDirectoryVisitorFunc

description: File and directory visitor function that takes only the name

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const TCHAR *, bool)> FDirectoryVisitorFunc


description: Return true if the file exists.

code: bool FileExists ( const TCHAR * Filename )


description: Return the size of the file, or -1 if it doesn't exist.

code: int64 FileSize ( const TCHAR * Filename )


description:
Finds all the files within the given directory, with optional file extension filter
FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

code: virtual void FindFiles ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension )


description:
Finds all the files within the directory tree, with optional file extension filter
FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

code: virtual void FindFilesRecursively ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension )


description: Return the last access time of a file. ReturnsFDateTime::MinValue()on failure

code: [FDateTime](API\Runtime\Core\Misc\FDateTime) GetAccessTimeStamp ( const TCHAR * Filename )


description: For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem

code: [FString](API\Runtime\Core\Containers\FString) GetFilenameOnDisk ( const TCHAR * Filename )


description:
Returns the number of bytes that are currently allowed to be written to throttled write storage (if the platform has such restrictions)
The number of bytes that are allowed to be written to write throttled storage. If there is no limit, INT64_MAX is returned

code: virtual int64 GetAllowedBytesToWriteThrottledStorage ( const TCHAR * DestinationPath )


description: Gets the platform file wrapped by this file.


description: Physical file system of theplatform, never wrapped.

code: static [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) & GetPlatformPhysical()


description: Gets this platform file type name.

code: const TCHAR * GetName() const


description: Returns the name of the physical platform file type.

code: static const TCHAR * GetPhysicalTypeName()


description: Return the stat data for the given file or directory. Check theFFileStatData::bIsValidmember before using the returned data

code: [FFileStatData](API\Runtime\Core\GenericPlatform\FFileStatData) GetStatData ( const TCHAR * FilenameOrDirectory )


description: Return the modification time of a file. ReturnsFDateTime::MinValue()on failure

code: [FDateTime](API\Runtime\Core\Misc\FDateTime) GetTimeStamp ( const TCHAR * Filename )


description: Return the modification time of a file in the local time of the calling code (GetTimeStamp returns UTC). ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetTimeStampLocal ( const TCHAR * Filename )


code: virtual void GetTimeStampPair ( const TCHAR * PathA, const TCHAR * PathB, [FDateTime](API\Runtime\Core\Misc\FDateTime) & OutTimeStampA, [FDateTime](API\Runtime\Core\Misc\FDateTime) & OutTimeStampB )


description:
Only works for files on disk and currently only implemented for Windows.
true if the file has a mark of the web, false otherwise.

code: virtual bool HasMarkOfTheWeb ( FStringView Filename, [FString](API\Runtime\Core\Containers\FString) * OutSourceURL )


description: Subclass fills out an archive to send to the server

code: void FillPayload &40; FArchive & Payload &41;


description: Subclass pulls data response from the server

code: void ProcessResponse &40; FArchive & Response &41;


className: IFileServerMessageHandler

description: Helper class to send/receive data to the file server function

code: class IFileServerMessageHandler


description:
Initializes platform file.
true if the initialization was successful, false otherise.

code: bool Initialize ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine )


description: Performs initialization of the platform file after the project path has been set.


description: Performs initialization of the platform file after the new async IO has been enabled

code: virtual void InitializeNewAsyncIO()


description: Performs initialization of the platform file after it has become the active (FPlatformFileManager.GetPlatformFile()will return this

code: virtual void InitializeAfterSetActive()


description: Return true if the file is read only.

code: bool IsReadOnly ( const TCHAR * Filename )


description:
Returns whether the sandbox is enabled or not
bool true if enabled, false if not

code: virtual bool IsSandboxEnabled() const


description:
Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
false if the directory did not exist or if the visitor returned false.

code: bool IterateDirectory ( const TCHAR * Directory, [FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description: Return true if the file is a symbolic link

code: virtual ESymlinkResult IsSymlink ( const TCHAR * Filename )


description:
Call the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectory ( const TCHAR * Directory, [FDirectoryVisitorFunc](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitorFunc) Visitor )


description:
Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectoryRecursively ( const TCHAR * Directory, [FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


code: virtual bool IterateDirectoryRecursively ( const TCHAR * Directory, [FDirectoryVisitorFunc](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitorFunc) Visitor )


code: bool IterateDirectoryStat ( const TCHAR * Directory, [FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


code: virtual bool IterateDirectoryStat ( const TCHAR * Directory, [FDirectoryStatVisitorFunc](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitorFunc) Visitor )


code: virtual bool IterateDirectoryStatRecursively ( const TCHAR * Directory, [FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


code: virtual bool IterateDirectoryStatRecursively ( const TCHAR * Directory, [FDirectoryStatVisitorFunc](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitorFunc) Visitor )


description: Build an in memory unique pak file from a subset of files in this pak file

code: virtual void MakeUniquePakFilesForTheseFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) >> & InFiles )


description: Attempt to move a file. Return true if successful. Will not overwrite existing files.

code: bool MoveFile ( const TCHAR * To, const TCHAR * From )


description:
Open a file for async reading. This call does not hit the disk or block.
Close the file by delete'ing the handle. A non-null return value does not mean the file exists, since that may not be determined yet.

code: virtual [IAsyncReadFileHandle](API\Runtime\Core\Async\IAsyncReadFileHandle) * OpenAsyncRead ( const TCHAR * Filename )


description:
Open a file for async reading. This call does hit the disk; it is synchronous open.
Close the file by delete'ing the handle. A non-null return value does mean the file exists. Null can be returned for many reasons even if the file exists. Perhaps this platform does not support mapped files, or this file is compressed in a pak file. Generally you attempt to open mapped, and if that fails, then use other file operations instead.

code: virtual [IMappedFileHandle](API\Runtime\Core\Async\IMappedFileHandle) * OpenMapped ( const TCHAR * Filename )


description:
Attempt to open a file for reading.
If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenRead ( const TCHAR * Filename, bool bAllowWrite )


description: Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenWrite ( const TCHAR * Filename, bool bAppend, bool bAllowRead )


code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenReadNoBuffering ( const TCHAR * Filename, bool bAllowWrite )


description:
Sends a message to the file server, and will block until it's complete. Will return immediately if the file manager doesn't support talking to a server.
true if the message was sent to server and it returned success, or false if there is no server, or the command failed

code: virtual bool SendMessageToServer ( const TCHAR * Message, [IFileServerMessageHandler](API\Runtime\Core\GenericPlatform\IPlatformFile\IFileServerMessageHandler) * Handler )


description: Controls if the pak precacher should process precache requests. Requests below this threshold will not get precached. Without this throttle, quite a lot of memory can be consumed if the disk races ahead of the CPU.

code: virtual void SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags MinPriority )


description: Sets file system to create publicly accessible files or not

code: virtual void SetCreatePublicFiles ( bool bCreatePublicFiles )


description: Sets the platform file wrapped by this file.

code: void SetLowerLevel ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * NewLowerLevel )


description:
Only works for files on disk and currently only implemented for Windows.
true if the file's mark of the web status was successful changed, false otherwise.

code: virtual bool SetMarkOfTheWeb ( FStringView Filename, bool bNewStatus, const [FString](API\Runtime\Core\Containers\FString) * InSourceURL )


description: Attempt to change the read only status of a file. Return true if successful.

code: bool SetReadOnly ( const TCHAR * Filename, bool bNewReadOnlyValue )


description: Set whether the sandbox is enabled or not

code: virtual void SetSandboxEnabled ( bool bInEnabled )


description: Sets the modification time of a file

code: void SetTimeStamp ( const TCHAR * Filename, [FDateTime](API\Runtime\Core\Misc\FDateTime) DateTime )


description: Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

code: virtual bool ShouldBeUsed ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine ) const


description: Platform file can override this to get a regular tick from the engine

code: virtual void Tick()


description: Destructor.

code: virtual ~IPlatformFile()


description:
Check if the host communication system is available and can be used.
True is available, false otherwise.

code: bool Available() const


className: IPlatformFile

description: File I/O Interface

code: class IPlatformFile


description: Close a communication channel previously opened using OpenConnection.

code: void CloseConnection ( IPlatformHostSocketPtr Socket )


description: Initialize the host communication system (done byIPlatformFeaturesModule).

code: void Initialize()


description:
Launch an executable on the connected host PC.
True on success, otherwise false (e.g. no permissions or incorrect executable path).

code: bool LaunchOnHost ( const char * BinaryPath, const char * CmdLine )


description: IPlatformHostSocket::GetState

code: IPlatformHostSocketPtr OpenConnection ( uint32 ProtocolIndex, const [FString](API\Runtime\Core\Containers\FString) & DebugName, uint32 Version, uint32 MinVersion )


description: Shutdown the host communication system (done byIPlatformFeaturesModule).

code: void Shutdown()


description: Virtual destructor.

code: virtual ~IPlatformHostCommunication()


className: IPlatformHostCommunication

description: It is meant to be used in development ONLY.

code: class IPlatformHostCommunication


className: EConnectionState

description: State of the socket determining its ability to send/receive data.

code: enum EConnectionState { Unknown, Created, Connected, Disconnected, Closed, }


className: EResultNet

description: Status values returned by Send and Receive members.

code: enum EResultNet { Ok, ErrorUnknown, ErrorInvalidArgument, ErrorInvalidConnection, ErrorInterrupted, ErrorHostNotConnected, }


description: Get the state of the socket (determines if the host pc is connected and communication is possible).


description:
Receive data from the connected host PC (blocking operation).
Status value indicating error or success.

code: [EResultNet](API\Runtime\Core\GenericPlatform\IPlatformHostSocket\EResultNet) Receive ( void * Buffer, uint64 BytesToReceive )


description:
Send data to the connected host PC (blocking operation).
Status value indicating error or success.

code: [EResultNet](API\Runtime\Core\GenericPlatform\IPlatformHostSocket\EResultNet) Send ( const void * Buffer, uint64 BytesToSend )


description: Destructor.

code: virtual ~IPlatformHostSocket()


className: IPlatformHostSocket

description: IPlatformHostCommunication

code: class IPlatformHostSocket


description: Generates a name for the disaster recovery service embedded in the CrashReporterClientEditor.

code: namespace RecoveryService { [FString](API\Runtime\Core\Containers\FString) RecoveryService::GetRecoveryServerName() }


description: Generates a name for the disaster recovery session.

code: namespace RecoveryService { [FString](API\Runtime\Core\Containers\FString) RecoveryService::MakeSessionName() }


description: Tokenize the session name into its components.

code: namespace RecoveryService { bool RecoveryService::TokenizeSessionName ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, [FString](API\Runtime\Core\Containers\FString) * OutServerName, int32 * SeqNum, [FString](API\Runtime\Core\Containers\FString) * ProjName, [FDateTime](API\Runtime\Core\Misc\FDateTime) * DateTime ) }


className: SelectIntPointerType

code: template<typename T32BITS, typename T64BITS, int PointerSize> struct SelectIntPointerType


className: TIntPointer

description: Select the 32 bit type.

code: typedef T32BITS TIntPointer


code: template<typename T32BITS, typename T64BITS> struct SelectIntPointerType< T32BITS, T64BITS, 4 >


description: Select the 64 bit type.

code: typedef T64BITS TIntPointer


code: template<typename T32BITS, typename T64BITS> struct SelectIntPointerType< T32BITS, T64BITS, 8 >


className: TCallTraits

description: TCallTraits< const T[N]>TCallTraits< T & >TCallTraits< T[N]>

code: template<typename T> struct TCallTraits : public [TCallTraitsBase< T >](API\Runtime\Core\Templates\TCallTraitsBase)


className: TFunction::operator bool

description: Tests if theTFunctionis callable.

code: FORCEINLINE operator bool() const


description: Move assignment operator.

code: [TFunction](API\Runtime\Core\GenericPlatform\TFunction) & operator= ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction) && Other )


description: Copy assignment operator.

code: [TFunction](API\Runtime\Core\GenericPlatform\TFunction) & operator= ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction) & Other )


description: Nullptr equality operator.

code: FORCEINLINEbool operator== ( TYPE_OF_NULLPTR ) const


description: Nullptr inequality operator.

code: FORCEINLINEbool operator!= ( TYPE_OF_NULLPTR ) const


description: Removes any bound callable from theTFunction, restoring it to the default 'empty' state.

code: void Reset()


description: Default constructor.

code: TFunction ( TYPE_OF_NULLPTR )


description: Constructor which binds aTFunctionto any function object.

code: template<typename FunctorType, typename> TFunction ( FunctorType && InFunc )


code: TFunction ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction) && )


code: TFunction ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction) & Other )


className: TFunction

description: See the class definition for intended usage.

code: template<typename FuncType> class TFunction : public [UE::Core::Private::Function::TFunctionRefBase< UE::Core::Private::Function::TFunctionStorage< false >, FuncType >](API\Runtime\Core\Templates\TFunctionRefBase)


className: bHasIntrusiveUnsetOptionalState

description: Start - intrusive TOptionalstate //.

code: static constexpr bool bHasIntrusiveUnsetOptionalState = true;


code: void operator= ( FIntrusiveUnsetOptionalState )


className: Super

code: typedef [UE::Core::Private::Function::TFunctionRefBase](API\Runtime\Core\Templates\TFunctionRefBase)< [UE::Core::Private::Function::TFunctionStorage](API\Runtime\Core\Templates\TFunctionStorage)< false >, FuncType > Super


description: We delete the assignment operators because we don't want it to be confused with being related to regular C++ reference assignment - i.e. calling the assignment operator of whatever the reference is bound to - because that's not whatTFunctionRefdoes, nor is it even capable of doing that.

code: [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef) & operator= ( const [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef) & ) const


code: bool operator== ( FIntrusiveUnsetOptionalState ) const


description: Constructor which binds aTFunctionRefto a callable object.

code: template<typename FunctorType, typename> TFunctionRef ( FunctorType &&InFunc UE_LIFETIMEBOUND )


code: TFunctionRef ( FIntrusiveUnsetOptionalState )


description: End - intrusive TOptionalstate //.

code: TFunctionRef ( const [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef) & )


className: TFunctionRef

code: template<typename FuncType> class TFunctionRef : public [UE::Core::Private::Function::TFunctionRefBase< UE::Core::Private::Function::FFunctionRefStoragePolicy, FuncType >](API\Runtime\Core\Templates\TFunctionRefBase)


code: [TGenericPlatformRWLock](API\Runtime\Core\GenericPlatform\TGenericPlatformRWLock) & operator= ( const [TGenericPlatformRWLock](API\Runtime\Core\GenericPlatform\TGenericPlatformRWLock) & )


code: TGenericPlatformRWLock ( const [TGenericPlatformRWLock](API\Runtime\Core\GenericPlatform\TGenericPlatformRWLock) & )


className: TGenericPlatformRWLock

description: TGenericPlatformRWLock- Read/Write Mutex

code: template<class CriticalSection> class TGenericPlatformRWLock


description: Accessors.

code: T Get() const


description: Default constructor.

code: TProcHandle()


description: Initialization constructor.

code: TProcHandle ( T Other )


className: TProcHandle

description: Generic implementation for the process handle.

code: template<typename T, T InvalidHandleValue> struct TProcHandle

Handle

description: Platform specific handle.


className: Type

code: typedef EBuildConfiguration Type


code: void * AllocateImpl ( SIZE_T Size, uint32 CachedByteLimit, [FFreePageBlock](API\Runtime\Core\HAL\Allocators\FCachedOSPageAllocator\FFreePageBlock) * First, [FFreePageBlock](API\Runtime\Core\HAL\Allocators\FCachedOSPageAllocator\FFreePageBlock) * Last, uint32 & FreedPageBlocksNum, SIZE_T & CachedTotal, FCriticalSection * Mutex )


className: FFreePageBlock

code: struct FFreePageBlock


code: void FreeAllImpl ( [FFreePageBlock](API\Runtime\Core\HAL\Allocators\FCachedOSPageAllocator\FFreePageBlock) * First, uint32 & FreedPageBlocksNum, SIZE_T & CachedTotal, FCriticalSection * Mutex )


code: void FreeImpl ( void * Ptr, SIZE_T Size, uint32 NumCacheBlocks, uint32 CachedByteLimit, [FFreePageBlock](API\Runtime\Core\HAL\Allocators\FCachedOSPageAllocator\FFreePageBlock) * First, uint32 & FreedPageBlocksNum, SIZE_T & CachedTotal, FCriticalSection * Mutex, bool ThreadIsTimeCritical )


code: static bool IsOSAllocation ( SIZE_T Size, uint32 CachedByteLimit )


className: FCachedOSPageAllocator

code: struct FCachedOSPageAllocator


code: void * Allocate ( SIZE_T Size, uint32 AllocationHint, FCriticalSection * Mutex )


code: void Free ( void * Ptr, SIZE_T Size, FCriticalSection * Mutex, bool ThreadIsTimeCritical )


className: FPoolDescriptorBase

description: A structure that describes a pool of a particular size

code: struct FPoolDescriptorBase

Next

type: FPoolDescriptor...

description: Next in the list

VMSizeDivVirtualSizeAlignment

description: Total size to be deallocated, which includes both pool memory and all the descriptor/bookkeeping memory


code: void FreeAll ( FCriticalSection * Mutex )


description: Returns free memory in the pools

code: uint64 GetCachedFreeTotal()


className: Limits

code: enum Limits { NumAllocationSizeClasses = 64, MaxAllocationSizeToPool = NumAllocationSizeClasses * 65536, MaxOSAllocCacheSize = 64 * 1024 * 1024, MaxOSAllocsCached = 64, }


description: Refresh allocator if needed. (does nothing in that implementation)

code: void Refresh()


description: Update memory stats (does nothing in that implementation)

code: void UpdateStats()


className: FPooledVirtualMemoryAllocator

description: CachedOSPageAllocator sits "below" this and is used for allocs larger than the largest bucketed.

code: struct FPooledVirtualMemoryAllocator


description: Refresh cached os allocator if needed. Does nothing for this implementation.


className: TCachedOSPageAllocator

code: template<uint32 NumCacheBlocks, uint32 CachedByteLimit> struct TCachedOSPageAllocator : private [FCachedOSPageAllocator](API\Runtime\Core\HAL\Allocators\FCachedOSPageAllocator)


className: bPrecacheAsSoonAsPossible

code: enum { bPrecacheAsSoonAsPossible = 0 }


description: Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

code: virtual bool Close()


description: Close the file handle

code: virtual void CloseLowLevel()


description: Flushes cache and frees internal data.

code: virtual void FlushCache()


description: This is overridden for the specific Archive Types

code: virtual [FString](API\Runtime\Core\Containers\FString) GetArchiveName() const


code: bool InternalPrecache ( int64 PrecacheOffset, int64 PrecacheSize )


description:
This function will not change the current archive position.
false if precache operation is still pending, true otherwise

code: virtual bool Precache ( int64 PrecacheOffset, int64 PrecacheSize )


description: Returns true if the archive should suppress logging in case of error

code: bool IsSilent() const


description: Platform specific read

code: virtual void ReadLowLevel ( uint8 * Dest, int64 CountToRead, int64 & OutBytesRead )


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


description:
Platform specific seek
false on failure

code: virtual bool SeekLowLevel ( int64 InPos )


code: virtual void Serialize ( void * V, int64 Length )


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


code: FArchiveFileReaderGeneric ( [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * InHandle, const TCHAR * InFilename, int64 InSize, uint32 InBufferSize, uint32 InFlags )


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


className: FArchiveFileReaderGeneric

code: class FArchiveFileReaderGeneric : public [FArchive](API\Runtime\Core\Serialization\FArchive)

BufferArray

type: TArray64< uint8...

description: The contract for the BufferWindow and the low level pos is that if we have a BufferWindow and Pos is within it, then the LowLevel Pos is at the end of the BufferWindow If we do not have a BufferWindow, or Pos is outside of it, then LowLevel Pos is at Pos.

Filename

description: Filename for debugging purposes.

Handle

type: TUniquePtr<IFi...


description:
Close the file handle
false on failure

code: virtual bool CloseLowLevel()


description: Attempts to finish writing any buffered data to disk/permanent storage.

code: virtual void Flush()


description:
Doesn't flush the handle itself, so this data may be cached by the OS and not yet written to disk!
true if there was buffer data and it was written successfully, false if there was nothing to flush or the write failed

code: bool FlushBuffer()


description: Logs I/O error It is important to not call any platform API functions after the error occurred and before calling this functions as the system error code may get reset and will not be properly logged in this message.

code: void LogWriteError ( const TCHAR * Message )


description:
Platform specific write
false on failure

code: virtual bool WriteLowLevel ( const uint8 * Src, int64 CountToWrite )


code: FArchiveFileWriterGeneric ( [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * InHandle, const TCHAR * InFilename, int64 InPos, uint32 InBufferSize, uint32 InFlags )


className: FArchiveFileWriterGeneric

code: class FArchiveFileWriterGeneric : public [FArchive](API\Runtime\Core\Serialization\FArchive)

Filename

type: FString

description: Filename for debugging purposes


className: FArenaParams

code: struct FArenaParams

AdditionalBlockSizes

type: TArray< uint32 ...

AddressLimit

description: These are parameters you set

LargeBlockAlloc

type: TFunction< void...

description: These allow you to override the large block allocator.

MaxMemoryPerBlockSize

description: These are parameters are derived from other parameters

ReserveVM

type: TFunction<FPla...

description: This lambdas is similar to the platform virtual memory HAL and by default just call that.


description: Register a console command that takes an output device

code: FAutoConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithOutputDeviceDelegate & Command, uint32 Flags )


description: Register a console command that takes no arguments

code: FAutoConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandDelegate & Command, uint32 Flags )


description: Register a console command that takes a world argument

code: FAutoConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldDelegate & Command, uint32 Flags )


description: Register a console command that takes arguments

code: FAutoConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithArgsDelegate & Command, uint32 Flags )


description: Register a console command that takes arguments, a world argument and an output device

code: FAutoConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldArgsAndOutputDeviceDelegate & Command, uint32 Flags )


className: FAutoConsoleCommand

description: Autoregistering console command

code: class FAutoConsoleCommand : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


code: FAutoConsoleCommandWithArgsAndOutputDevice ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithArgsAndOutputDeviceDelegate & Command, uint32 Flags )


code: FAutoConsoleCommandWithOutputDevice ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithOutputDeviceDelegate & Command, uint32 Flags )


description: Autoregistering console command with args and an output device

code: class FAutoConsoleCommandWithArgsAndOutputDevice : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


className: FAutoConsoleCommandWithOutputDevice

description: Autoregistering console command with an output device

code: class FAutoConsoleCommandWithOutputDevice : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


className: FAutoConsoleCommandWithWorld

description: Autoregistering console command with a world

code: class FAutoConsoleCommandWithWorld : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


description: Register a console command that takes arguments and a world argument

code: FAutoConsoleCommandWithWorldAndArgs ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldAndArgsDelegate & Command, uint32 Flags )


className: FAutoConsoleCommandWithWorldAndArgs

description: Autoregistering console command with a world and arguments

code: class FAutoConsoleCommandWithWorldAndArgs : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


code: FAutoConsoleCommandWithWorldArgsAndOutputDevice ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldArgsAndOutputDeviceDelegate & Command, uint32 Flags )


description: Autoregistering console command with world, args, an output device

code: class FAutoConsoleCommandWithWorldArgsAndOutputDevice : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


code: static [TArray](API\Runtime\Core\Containers\TArray)< const [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject) * > & AccessDesktopShaderChangeCvars()


code: FAutoConsoleCommandWithWorld ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldDelegate & Command, uint32 Flags )


code: static [TArray](API\Runtime\Core\Containers\TArray)< const [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject) * > & AccessGeneralShaderChangeCvars()


description: Returns the contained console object as anIConsoleVariable


code: static [TArray](API\Runtime\Core\Containers\TArray)< const [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject) * > & AccessMobileShaderChangeCvars()


code: const [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * AsVariable() const


description: Constructor, saves the argument for future removal from the console variable system

code: FAutoConsoleObject ( [IConsoleObject](API\Runtime\Core\HAL\IConsoleObject) * InTarget )


description: Destructor, removes the console object

code: virtual ~FAutoConsoleObject()


className: FAutoConsoleObject

description: Base class for autoregistering console commands.

code: class FAutoConsoleObject


description: Dereference back to a console variable


code: const [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * operator->() const


code: const [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) & operator*() const


description: Create a bool console variable

code: FAutoConsoleVariable ( const TCHAR * Name, bool DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a int console variable

code: FAutoConsoleVariable ( const TCHAR * Name, int32 DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a float console variable

code: FAutoConsoleVariable ( const TCHAR * Name, float DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a string console variable

code: FAutoConsoleVariable ( const TCHAR * Name, const TCHAR * DefaultValue, const TCHAR * Help, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariable ( const TCHAR * Name, bool DefaultValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariable ( const TCHAR * Name, int32 DefaultValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariable ( const TCHAR * Name, float DefaultValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariable ( const TCHAR * Name, const TCHAR * DefaultValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


className: FAutoConsoleVariable

description: Autoregistering float, int or string console variable

code: class FAutoConsoleVariable : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


description: Dereference back to a variable


description: Create a reference to a int console variable

code: FAutoConsoleVariableRef ( const TCHAR * Name, int32 & RefValue, const TCHAR * Help, uint32 Flags )


description: Create a reference to a float console variable

code: FAutoConsoleVariableRef ( const TCHAR * Name, float & RefValue, const TCHAR * Help, uint32 Flags )


description: Create a reference to a bool console variable

code: FAutoConsoleVariableRef ( const TCHAR * Name, bool & RefValue, const TCHAR * Help, uint32 Flags )


description: Create a reference to aFStringconsole variable

code: FAutoConsoleVariableRef ( const TCHAR * Name, [FString](API\Runtime\Core\Containers\FString) & RefValue, const TCHAR * Help, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariableRef ( const TCHAR * Name, int32 & RefValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariableRef ( const TCHAR * Name, float & RefValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariableRef ( const TCHAR * Name, bool & RefValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


description: IConsoleVariable::SetOnChangedCallback

code: FAutoConsoleVariableRef ( const TCHAR * Name, [FString](API\Runtime\Core\Containers\FString) & RefValue, const TCHAR * Help, const FConsoleVariableDelegate & Callback, uint32 Flags )


className: FAutoConsoleVariableRef

description: Autoregistering float, int, bool,FStringREF variable class...this changes that value when the console variable is changed.

code: class FAutoConsoleVariableRef : private [FAutoConsoleObject](API\Runtime\Core\HAL\FAutoConsoleObject)


code: FAutoConsoleVariableSink ( const FConsoleCommandDelegate & InCommand )


description: Destructor, removes the console variable sink

code: virtual ~FAutoConsoleVariableSink()


className: FAutoConsoleVariableSink

description: Auto registering console variable sinks (register a callback function that is called when ever a cvar is changes by the user, changes are grouped and happen in specific engine spots during the frame/main loop)

code: class FAutoConsoleVariableSink

Command

type: const FConsoleC...

Handle

type: FConsoleVariabl...


code: uint32 CountOnes ( uint32 UpTo ) const


code: void FBitTreeInit ( uint32 InDesiredCapacity, void * Memory, uint32 MemorySize, bool InitialValue )


code: static uint32 GetMemoryRequirements ( uint32 DesiredCapacity )


code: bool IsAllocated ( uint32 Index ) const


code: uint32 NextAllocBit ( uint32 StartIndex ) const


className: BufferCacheSize

code: static constexpr uint32 BufferCacheSize = 64 * 1024;


className: CacheCount

code: static constexpr uint32 CacheCount = 2;


className: BufferSizeMask

code: static constexpr uint64 BufferSizeMask = ~((uint64)BufferCacheSize-1);


description:
Flushes file handle to disk.
true if operation completed successfully.

code: virtual bool Flush ( const bool bFullFlush )


description:
Read bytes from the file.
true if the operation completed successfully.

code: virtual bool Read ( uint8 * Destination, int64 BytesToRead )


description:
Change the current write or read position.
true if the operation completed successfully.

code: virtual bool Seek ( int64 NewPosition )


description:
Change the current write or read position, relative to the end of the file.
true if the operation completed successfully.

code: virtual bool SeekFromEnd ( int64 NewPositionRelativeToEnd )


description: Minimizes optional system or process cache kept for the file.

code: virtual void ShrinkBuffers()


description: Return the total size of the file

code: virtual int64 Size()


description:
Truncate the file to the given size (in bytes).
true if the operation completed successfully.

code: virtual bool Truncate ( int64 NewSize )


description: Return the current write or read position.

code: virtual int64 Tell()


description:
Write bytes to the file.
true if the operation completed successfully.

code: virtual bool Write ( const uint8 * Source, int64 BytesToWrite )


code: FCachedFileHandle ( [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * InFileHandle, bool bInReadable, bool bInWritable )


description:
Converts passed in filename to use an absolute path (for reading).
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )


className: FCachedFileHandle

code: class FCachedFileHandle : public [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle)


description:
Converts passed in filename to use an absolute path (for writing)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )


description:
Copy a file or a hierarchy of files (directory).
true if operation completed successfully.

code: virtual bool CopyDirectoryTree ( const TCHAR * DestinationDirectory, const TCHAR * Source, bool bOverwriteAllExisting )


description:
Copy a file. This will fail if the destination file already exists.
true if the file was copied sucessfully.

code: virtual bool CopyFile ( const TCHAR * To, const TCHAR * From, EPlatformFileRead ReadFlags, EPlatformFileWrite WriteFlags )


description: Create a directory, including any parent directories and return true if the directory was created or already existed.

code: virtual bool CreateDirectoryTree ( const TCHAR * Directory )


description: Delete a directory and return true if the directory was deleted or otherwise does not exist.

code: virtual bool DeleteDirectory ( const TCHAR * Directory )


description: Create a directory and return true if the directory was created or already existed.

code: virtual bool CreateDirectory ( const TCHAR * Directory )


description:
Delete all files and subdirectories in a directory, then delete the directory itself
true if the directory was deleted or did not exist.

code: virtual bool DeleteDirectoryRecursively ( const TCHAR * Directory )


description: Delete a file and return true if the file exists. Will not delete read only files.

code: virtual bool DeleteFile ( const TCHAR * Filename )


description: Return true if the file exists.

code: virtual bool FileExists ( const TCHAR * Filename )


description: Return true if the directory exists.

code: virtual bool DirectoryExists ( const TCHAR * Directory )


description:
Finds all the files within the given directory, with optional file extension filter
FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

code: virtual void FindFiles ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension )


description:
Finds all the files within the directory tree, with optional file extension filter
FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

code: virtual void FindFilesRecursively ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension )


description: Return the size of the file, or -1 if it doesn't exist.

code: virtual int64 FileSize ( const TCHAR * Filename )


description: Return the last access time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetAccessTimeStamp ( const TCHAR * Filename )


description: For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem

code: virtual [FString](API\Runtime\Core\Containers\FString) GetFilenameOnDisk ( const TCHAR * Filename )


description: Gets the platform file wrapped by this file.

code: virtual [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * GetLowerLevel()


description: Gets this platform file type name.

code: virtual const TCHAR * GetName() const


description: Return the stat data for the given file or directory. Check theFFileStatData::bIsValidmember before using the returned data

code: virtual [FFileStatData](API\Runtime\Core\GenericPlatform\FFileStatData) GetStatData ( const TCHAR * FilenameOrDirectory )


description: Return the modification time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetTimeStamp ( const TCHAR * Filename )


description:
Initializes platform file.
true if the initialization was successful, false otherise.

code: virtual bool Initialize ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine )


description: Return true if the file is read only.

code: virtual bool IsReadOnly ( const TCHAR * Filename )


description:
Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectory ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description:
Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectoryRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


code: virtual bool IterateDirectoryStatRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


code: virtual bool IterateDirectoryStat ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


description:
Open a file for async reading. This call does not hit the disk or block.
Close the file by delete'ing the handle. A non-null return value does not mean the file exists, since that may not be determined yet.

code: virtual [IAsyncReadFileHandle](API\Runtime\Core\Async\IAsyncReadFileHandle) * OpenAsyncRead ( const TCHAR * Filename )


description:
Open a file for async reading. This call does hit the disk; it is synchronous open.
Close the file by delete'ing the handle. A non-null return value does mean the file exists. Null can be returned for many reasons even if the file exists. Perhaps this platform does not support mapped files, or this file is compressed in a pak file. Generally you attempt to open mapped, and if that fails, then use other file operations instead.

code: virtual [IMappedFileHandle](API\Runtime\Core\Async\IMappedFileHandle) * OpenMapped ( const TCHAR * Filename )


description: Attempt to move a file. Return true if successful. Will not overwrite existing files.

code: virtual bool MoveFile ( const TCHAR * To, const TCHAR * From )


description:
Attempt to open a file for reading.
If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenRead ( const TCHAR * Filename, bool bAllowWrite )


description: Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenWrite ( const TCHAR * Filename, bool bAppend, bool bAllowRead )


description:
Sends a message to the file server, and will block until it's complete. Will return immediately if the file manager doesn't support talking to a server.
true if the message was sent to server and it returned success, or false if there is no server, or the command failed

code: virtual bool SendMessageToServer ( const TCHAR * Message, [IFileServerMessageHandler](API\Runtime\Core\GenericPlatform\IPlatformFile\IFileServerMessageHandler) * Handler )


description: Controls if the pak precacher should process precache requests. Requests below this threshold will not get precached. Without this throttle, quite a lot of memory can be consumed if the disk races ahead of the CPU.

code: virtual void SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags MinPriority )


description: Sets the platform file wrapped by this file.

code: virtual void SetLowerLevel ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * NewLowerLevel )


description: Attempt to change the read only status of a file. Return true if successful.

code: virtual bool SetReadOnly ( const TCHAR * Filename, bool bNewReadOnlyValue )


description: Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

code: virtual bool ShouldBeUsed ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine ) const


description: Sets the modification time of a file

code: virtual void SetTimeStamp ( const TCHAR * Filename, [FDateTime](API\Runtime\Core\Misc\FDateTime) DateTime )


code: virtual void AddConsoleHistoryEntry ( const TCHAR * Key, const TCHAR * Input )


className: FCachedReadPlatformFile

code: class FCachedReadPlatformFile : public [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile)


description: The sinks are only called if a change has been done since the last time Should be called in very few points:


description:
Find a console variable or command
0 if the object wasn't found

code: virtual [IConsoleObject](API\Runtime\Core\HAL\IConsoleObject) * FindConsoleObject ( const TCHAR * Name, bool bTrackFrequentCalls ) const


description: Lookup the name of a console object by its pointer

code: virtual [FString](API\Runtime\Core\Containers\FString) FindConsoleObjectName ( const [IConsoleObject](API\Runtime\Core\HAL\IConsoleObject) * Obj ) const


description:
Find a console variable
0 if the object wasn't found

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * FindConsoleVariable ( const TCHAR * Name, bool bTrackFrequentCalls ) const


description: Not case sensitive, does not guarantee thatUnregisterConsoleObject()will work in the loop

code: virtual void ForEachConsoleObjectThatContains ( const FConsoleObjectVisitor & Visitor, const TCHAR * ThatContains ) const


description: Iterate in O(n), not case sensitive, does not guarantee thatUnregisterConsoleObject()will work in the loop

code: virtual void ForEachConsoleObjectThatStartsWith ( const FConsoleObjectVisitor & Visitor, const TCHAR * ThatStartsWith ) const


code: virtual void GetConsoleHistory ( const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Out )


description: Internally needed or ECVF_RenderThreadSafe


description: Check if a name (command or variable) has been registered with the console manager

code: virtual bool IsNameRegistered ( const TCHAR * Name ) const


code: bool IsThreadPropagationThread()


code: virtual FConsoleVariableMulticastDelegate & OnCVarUnregistered()


description:
Process user input e.g. "MyCVar" to get the current value of the console variable "MyCVar -5.2" to set the value to -5.2 "MyCVar ?" to get the help text
true if the command was recognized

code: virtual bool ProcessUserConsoleInput ( const TCHAR * Input, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar, [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld )


description: Register a console command that is handles by an Exec functions (for auto completion)

code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, uint32 Flags )


description: Register a console command that takes no arguments

code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandDelegate & Command, uint32 Flags )


description: Register a console command that takes arguments

code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithArgsDelegate & Command, uint32 Flags )


code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldDelegate & Command, uint32 Flags )


code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldAndArgsDelegate & Command, uint32 Flags )


code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithArgsAndOutputDeviceDelegate & Command, uint32 Flags )


code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithWorldArgsAndOutputDeviceDelegate & Command, uint32 Flags )


code: virtual [IConsoleCommand](API\Runtime\Core\HAL\IConsoleCommand) * RegisterConsoleCommand ( const TCHAR * Name, const TCHAR * Help, const FConsoleCommandWithOutputDeviceDelegate & Command, uint32 Flags )


description: Create a bool console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariable ( const TCHAR * Name, bool DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a int console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariable ( const TCHAR * Name, int32 DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a float console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariable ( const TCHAR * Name, float DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a string console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariable ( const TCHAR * Name, const TCHAR * DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a string console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariable ( const TCHAR * Name, const [FString](API\Runtime\Core\Containers\FString) & DefaultValue, const TCHAR * Help, uint32 Flags )


description: Create a reference to a show flag variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariableBitRef ( const TCHAR * CVarName, const TCHAR * FlagName, uint32 BitNumber, uint8 * Force0MaskPtr, uint8 * Force1MaskPtr, const TCHAR * Help, uint32 Flags )


description: Create a reference to a bool console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariableRef ( const TCHAR * Name, bool & RefValue, const TCHAR * Help, uint32 Flags )


description: Create a reference to a int console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariableRef ( const TCHAR * Name, int32 & RefValue, const TCHAR * Help, uint32 Flags )


description: Create a reference to a float console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariableRef ( const TCHAR * Name, float & RefValue, const TCHAR * Help, uint32 Flags )


description: Create a reference to a string console variable

code: virtual [IConsoleVariable](API\Runtime\Core\HAL\IConsoleVariable) * RegisterConsoleVariableRef ( const TCHAR * Name, [FString](API\Runtime\Core\Containers\FString) & RefValue, const TCHAR * Help, uint32 Flags )


description: The registered command is executed at few defined points (see CallAllConsoleVariableSinks)

code: virtual [FConsoleVariableSinkHandle](API\Runtime\Core\HAL\FConsoleVariableSinkHandle) RegisterConsoleVariableSink_Handle ( const FConsoleCommandDelegate & Command )


description: Currently only for render thread

code: virtual void RegisterThreadPropagation ( uint32 ThreadId, [IConsoleThreadPropagation](API\Runtime\Core\HAL\IConsoleThreadPropagation) * InCallback )


description: Can be moved out into some automated testing system

code: void Test()


description: Unregisters a console object, if that object was registered. O(n), n is the console object count

code: virtual void UnregisterConsoleObject ( [IConsoleObject](API\Runtime\Core\HAL\IConsoleObject) * ConsoleObject, bool bKeepState )


description: Unregisters a console variable or command, if that object was registered. For console variables, this will actually only "deactivate" the variable so if it becomes registered again the state may persist (unless bKeepState is false).

code: virtual void UnregisterConsoleObject &40; const TCHAR &42; Name, bool bKeepState &41;


code: virtual void UnregisterConsoleVariableSink_Handle ( [FConsoleVariableSinkHandle](API\Runtime\Core\HAL\FConsoleVariableSinkHandle) Handle )


description: Constructor

code: FConsoleManager()


description: Destructor

code: ~FConsoleManager()


className: FConsoleManager

code: class FConsoleManager : public [IConsoleManager](API\Runtime\Core\HAL\IConsoleManager)


code: template<typename DelegateType> bool HasSameHandle ( const DelegateType & Delegate ) const


code: template<typename MulticastDelegateType> void RemoveFromDelegate ( MulticastDelegateType & MulticastDelegate )


code: FConsoleVariableSinkHandle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle )


className: FConsoleVariableSinkHandle

description: Class representing an handle to an online delegate.

code: class FConsoleVariableSinkHandle


className: FDisableHitchDetectorScope

description: Suspends hitch detection in the current scope

code: struct FDisableHitchDetectorScope


description: Advances stats associated with this event. Used to monitor wait->trigger history.

code: void AdvanceStats()


description:
Manually reset events stay triggered until reset. Named events share the same underlying event.
true if the event was created, false otherwise.

code: bool Create ( bool bIsManualReset )


className: EventUniqueId

description: Counter used to generate an unique id for the events.

code: static [TAtomic](API\Runtime\Core\HAL\TAtomic)< uint32 > EventUniqueId;


description: Reset

code: bool IsManualReset()


description: Trigger

code: void Reset()


description: Resets start cycles to 0.

code: void ResetForStats()


description: Reset

code: void Trigger()


description: Send to the stats a special message which encodes a trigger for the event.

code: void TriggerForStats()


description:
Waits an infinite amount of time for the event to be triggered.
true if the event was triggered.

code: bool Wait()


description:
A wait time of MAX_uint32 is treated as infinite wait.
true if the event was triggered, false if the wait timed out.

code: bool Wait ( uint32 WaitTime, const bool bIgnoreThreadIdleStats )


description:
Waits the specified amount of time for the event to be triggered.
true if the event was triggered, false if the wait timed out.

code: bool Wait ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & WaitTime, const bool bIgnoreThreadIdleStats )


description: Sends to the stats a special messages which encodes a wait for the event.

code: void WaitForStats()


description: Default constructor.

code: FEvent()


description: Virtual destructor.

code: virtual ~FEvent()


className: FEvent

description: Consider usingFEventRefas a safer and more convenient alternative.

code: class FEvent

EventId

description: An unique id of this event.

EventStartCycles

type: TAtomic< uint32...

description: Greater than 0, if the event called wait.


code: [FEvent](API\Runtime\Core\HAL\FEvent) * operator->() const


code: [FEventRef](API\Runtime\Core\HAL\FEventRef) & operator= ( const [FEventRef](API\Runtime\Core\HAL\FEventRef) & )


code: [FEventRef](API\Runtime\Core\HAL\FEventRef) & operator= ( [FEventRef](API\Runtime\Core\HAL\FEventRef) && Other )


code: FEventRef ( [FEventRef](API\Runtime\Core\HAL\FEventRef) && Other )


code: FEventRef ( const [FEventRef](API\Runtime\Core\HAL\FEventRef) & )


className: FEventRef

description: non-copyable, non-movable

code: class FEventRef


code: virtual [FContextSupplier](API\Runtime\Core\Misc\FContextSupplier) * GetContext() const


code: static void LocalPrint ( const TCHAR * Str )


code: virtual void Serialize ( const TCHAR * V, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const [FName](API\Runtime\Core\UObject\FName) & Category )


code: virtual void Serialize ( const TCHAR * V, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const [FName](API\Runtime\Core\UObject\FName) & Category, double Time )


code: virtual void SerializeRecord ( const [UE::FLogRecord](API\Runtime\Core\Logging\FLogRecord) & Record )


description: Ask the user a binary question, returning their answer

code: virtual bool YesNof ( const [FText](API\Runtime\Core\Internationalization\FText) & Question )


code: virtual void SetContext ( [FContextSupplier](API\Runtime\Core\Misc\FContextSupplier) * InContext )


className: FFeedbackContextAnsi

code: class FFeedbackContextAnsi : public [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext)

AuxOut

type: FOutputDevice&...

Context

type: FContextSupplie...


code: [FRegisteredFileHandle](API\Runtime\Core\HAL\FRegisteredFileHandle) * InitialOpenFile ( const TCHAR * Filename )


code: void PlatformCloseFile ( [FRegisteredFileHandle](API\Runtime\Core\HAL\FRegisteredFileHandle) * )


code: [FRegisteredFileHandle](API\Runtime\Core\HAL\FRegisteredFileHandle) * PlatformInitialOpenFile ( const TCHAR * Filename )


code: bool PlatformReopenFile ( [FRegisteredFileHandle](API\Runtime\Core\HAL\FRegisteredFileHandle) * )


code: void TrackEndRead ( [FRegisteredFileHandle](API\Runtime\Core\HAL\FRegisteredFileHandle) * Handle )


code: void TrackStartRead ( [FRegisteredFileHandle](API\Runtime\Core\HAL\FRegisteredFileHandle) * Handle )


code: void UnTrackAndCloseFile ( [FRegisteredFileHandle](API\Runtime\Core\HAL\FRegisteredFileHandle) * Handle )


code: FFileHandleRegistry ( int32 InMaxOpenHandles )


className: FFileHandleRegistry

code: class FFileHandleRegistry


description:
Converts passed in filename to use an absolute path (for reading)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )


description:
Converts passed in filename to use an absolute path (for writing)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )


description:
Converts passed in filename to use a relative path.
filename using relative path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToRelativePath ( const TCHAR * Filename )


description: Copies a file.

code: virtual uint32 Copy ( const TCHAR * Dest, const TCHAR * Src, bool Replace, bool EvenIfReadOnly, bool Attributes, [FCopyProgress](API\Runtime\Core\HAL\FCopyProgress) * Progress, EFileRead ReadFlags, EFileWrite WriteFlags )


description:
Opens a file for reading and create anFArchivewhich can be used to read from it.
Returns a pointer to anFArchivewhen successful and a nullptr if the operation failed. Note that it is up to the caller to delete theFArchivewhen done.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * CreateFileReader ( const TCHAR * Filename, uint32 ReadFlags )


description:
Opens a file for writing and create anFArchivewhich can be used to write to it.
Returns a pointer to anFArchivewhen successful and a nullptr if the operation failed. Note that it is up to the caller to delete theFArchivewhen done.

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * CreateFileWriter ( const TCHAR * Filename, uint32 WriteFlags )


code: static [FString](API\Runtime\Core\Containers\FString) DefaultConvertToRelativePath ( const TCHAR * Filename )


description: Deletes a file.

code: virtual bool Delete ( const TCHAR * Filename, bool RequireExists, bool EvenReadOnly, bool Quiet )


description: Deletes a directory.

code: virtual bool DeleteDirectory ( const TCHAR * Path, bool RequireExists, bool Tree )


description: Checks if a directory exists.

code: virtual bool DirectoryExists ( const TCHAR * InDirectory )


description: Checks if a file exists

code: virtual bool FileExists ( const TCHAR * Filename )


description:
Returns the size of a file. (Thread-safe)
File size in bytes or INDEX_NONE if the file didn't exist.

code: virtual int64 FileSize ( const TCHAR * Filename )


description:
Finds all the files within the given directory, with optional file extension filter.
FoundFiles, All the files that matched the optional FileExtension filter, or all files if none was specified.

code: virtual void FindFiles ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension )


description: Finds file or directories.

code: virtual void FindFiles ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FileNames, const TCHAR * Filename, bool Files, bool Directories )


description: Finds file or directories recursively.

code: virtual void FindFilesRecursive ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FileNames, const TCHAR * StartDirectory, const TCHAR * Filename, bool Files, bool Directories, bool bClearFileNames )


description: the last access time of the given file (orFDateTime::MinValue()on failure)

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetAccessTimeStamp ( const TCHAR * Filename )


description: Gets the age of a file measured in seconds.

code: virtual double GetFileAgeSeconds ( const TCHAR * Filename )