1. Epic GamesDeveloper
  3. FSandboxPlatformFile

FSandboxPlatformFile

Wrapper to log the low level file system

API > API/Runtime > API/Runtime/SandboxFile

Wrapper to log the low level file system

   
Name FSandboxPlatformFile
Type class
Header File /Engine/Source/Runtime/SandboxFile/Public/IPlatformFileSandboxWrapper.h
Include Path #include "IPlatformFileSandboxWrapper.h"

Syntax

class FSandboxPlatformFile : public IPlatformFile

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FSandboxPlatformFile ( bool bInEntireEngineWillUseThisSandbox
)

 Converts passed in filename to use a sandbox path. IPlatformFileSandboxWrapper.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FSandboxPlatformFile()

   IPlatformFileSandboxWrapper.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AbsoluteGameDirectory FString Absolute game directory. Cached for faster access IPlatformFileSandboxWrapper.h  
AbsolutePathToGameDirectory FString Absolute path to game directory. Cached for faster access IPlatformFileSandboxWrapper.h  
AbsoluteRootDirectory FString Absolute path to root directory. Cached for faster access IPlatformFileSandboxWrapper.h  
bEntireEngineWillUseThisSandbox bool   IPlatformFileSandboxWrapper.h  
bSandboxEnabled bool Whether the sandbox is enabled or not. IPlatformFileSandboxWrapper.h  
bSandboxOnly bool Whether access is restricted to the sandbox or not. Defaults to false. IPlatformFileSandboxWrapper.h  
DirectoryExclusionWildcards TArray< FString > Access to any directory (in unreal standard form) matching this is not allowed IPlatformFileSandboxWrapper.h  
FileExclusionWildcards TArray< FString > Access to any file (in unreal standard form) matching this is not allowed IPlatformFileSandboxWrapper.h  
GameSandboxDirectoryName FString Name of the game's sandbox directory IPlatformFileSandboxWrapper.h  
InjectedSourceDirectory FString For an injection sandbox, we insert the contents of one directory into the contents of another directory (InjectedSource) in the eyes of the engine (InjectedTarget). IPlatformFileSandboxWrapper.h  
InjectedSourceDirectoryParent FString   IPlatformFileSandboxWrapper.h  
InjectedTargetDirectory FString   IPlatformFileSandboxWrapper.h  
InjectedTargetDirectoryParent FString   IPlatformFileSandboxWrapper.h  
LowerLevel IPlatformFile * Wrapped file IPlatformFileSandboxWrapper.h  
RelativeRootDirectory FString Relative path to root directory. Cached for faster access IPlatformFileSandboxWrapper.h  
SandboxDirectory FString Absolute path to the sandbox directory IPlatformFileSandboxWrapper.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddExclusion ( const TCHAR* Wildcard,
bool bIsDirectory
)

 Add exclusion. IPlatformFileSandboxWrapper.h  

FString ConvertFromSandboxPath ( const TCHAR* Filename
) const

   IPlatformFileSandboxWrapper.h  

virtual FString ConvertToAbsolutePathForExternalAppForRead ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

virtual FString ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

FString ConvertToSandboxPath ( const TCHAR* Filename
) const

 Converts passed in filename to use a sandbox path. IPlatformFileSandboxWrapper.h  

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

   IPlatformFileSandboxWrapper.h  

virtual bool CreateDirectory ( const TCHAR* Directory
)

   IPlatformFileSandboxWrapper.h  

virtual bool CreateDirectoryTree ( const TCHAR* Directory
)

   IPlatformFileSandboxWrapper.h  

virtual bool DeleteDirectory ( const TCHAR* Directory
)

   IPlatformFileSandboxWrapper.h  

virtual bool DeleteDirectoryRecursively ( const TCHAR* Directory
)

   IPlatformFileSandboxWrapper.h  

virtual bool DeleteFile ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

virtual bool DirectoryExists ( const TCHAR* Directory
)

   IPlatformFileSandboxWrapper.h  

virtual bool FileExists ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

virtual int64 FileSize ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

const FString & GetAbsoluteGameDirectory()

 Returns absolute game directory IPlatformFileSandboxWrapper.h  

const FString & GetAbsolutePathToGameDirectory()

 Returns absolute path to game directory (without the game directory itself) IPlatformFileSandboxWrapper.h  

const FString & GetAbsoluteRootDirectory()

 Returns absolute root directory IPlatformFileSandboxWrapper.h  

virtual FDateTime GetAccessTimeStamp ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

virtual FString GetFilenameOnDisk ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

const FString & GetGameSandboxDirectoryName()

 Returns the name of the sandbox directory for the game's content IPlatformFileSandboxWrapper.h  

virtual IPlatformFile * GetLowerLevel()

   IPlatformFileSandboxWrapper.h  

virtual const TCHAR * GetName()

   IPlatformFileSandboxWrapper.h  

const FString & GetSandboxDirectory()

 Returns sandbox directory IPlatformFileSandboxWrapper.h  

virtual FFileStatData GetStatData ( const TCHAR* FilenameOrDirectory
)

   IPlatformFileSandboxWrapper.h  

virtual FDateTime GetTimeStamp ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

virtual bool Initialize ( IPlatformFile* Inner,
const TCHAR* CmdLine
)

   IPlatformFileSandboxWrapper.h  

virtual bool IsReadOnly ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

virtual bool IsSandboxEnabled()

 Returns whether the sandbox is enabled or not IPlatformFileSandboxWrapper.h  

virtual bool IterateDirectory ( const TCHAR* Directory,
IPlatformFile::FDirectoryVisitor& Visitor
)

   IPlatformFileSandboxWrapper.h  

virtual bool IterateDirectoryRecursively ( const TCHAR* Directory,
IPlatformFile::FDirectoryVisitor& Visitor
)

   IPlatformFileSandboxWrapper.h  

virtual bool IterateDirectoryStat ( const TCHAR* Directory,
IPlatformFile::FDirectoryStatVisitor& Visitor
)

   IPlatformFileSandboxWrapper.h  

virtual bool IterateDirectoryStatRecursively ( const TCHAR* Directory,
IPlatformFile::FDirectoryStatVisitor& Visitor
)

   IPlatformFileSandboxWrapper.h  

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

   IPlatformFileSandboxWrapper.h  

virtual IAsyncReadFileHandle * OpenAsyncRead ( const TCHAR* Filename,
bool bAllowWrite
)

   IPlatformFileSandboxWrapper.h  

virtual IMappedFileHandle * OpenMapped ( const TCHAR* Filename
)

   IPlatformFileSandboxWrapper.h  

virtual FOpenMappedResult OpenMappedEx ( const TCHAR* Filename,
EOpenReadFlags OpenOptions,
int64 MaximumSize
)

   IPlatformFileSandboxWrapper.h  

virtual IFileHandle * OpenRead ( const TCHAR* Filename,
bool bAllowWrite
)

   IPlatformFileSandboxWrapper.h  

virtual IFileHandle * OpenWrite ( const TCHAR* Filename,
bool bAppend,
bool bAllowRead
)

   IPlatformFileSandboxWrapper.h  

void RemoveExclusion ( const TCHAR* Wildcard,
bool bIsDirectory
)

   IPlatformFileSandboxWrapper.h  

virtual void SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags Priority
)

   IPlatformFileSandboxWrapper.h  

virtual void SetLowerLevel ( IPlatformFile* NewLowerLevel
)

   IPlatformFileSandboxWrapper.h  

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

   IPlatformFileSandboxWrapper.h  

virtual void SetSandboxEnabled ( bool bInEnabled
)

 Set whether the sandbox is enabled or not IPlatformFileSandboxWrapper.h  

void SetSandboxOnly ( bool bInSandboxOnly
)

 Whether access is restricted the the sandbox or not. IPlatformFileSandboxWrapper.h  

virtual void SetTimeStamp ( const TCHAR* Filename,
FDateTime DateTime
)

   IPlatformFileSandboxWrapper.h  

virtual bool ShouldBeUsed ( IPlatformFile* Inner,
const TCHAR* CmdLine
) const

   IPlatformFileSandboxWrapper.h  

Static

Name Remarks Include Path Unreal Specifiers

static TUniquePtr< FSandboxPlatformFile > Create ( bool bInEntireEngineWillUseThisSandbox
)

   IPlatformFileSandboxWrapper.h  

static const TCHAR * GetTypeName()

   IPlatformFileSandboxWrapper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page