1. Epic GamesDeveloper
  3. IFileManager

IFileManager

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/HAL

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/HAL/FileManager.h
Include #include "HAL/FileManager.h"

Syntax

class IFileManager

Constructors

  Type Name Description
Protected function   Construtor.

Functions

  Type Name Description
Public function FString

ConvertToAbsolutePathForExternalAppForRead ( const TCHAR* Filename
)

 Converts passed in filename to use an absolute path (for reading)
Public function FString Converts passed in filename to use an absolute path (for writing)
Public function FString

ConvertToRelativePath ( const TCHAR* Filename
)

 Converts passed in filename to use a relative path.
Public function uint32

Copy ( const TCHAR* Dest,
const TCHAR* Src,
bool Replace,
bool EvenIfReadOnly,
bool Attributes,
FCopyProgress* Progress,
EFileRead ReadFlags,
EFileWrite WriteFlags
)

 Copies a file.
Public function FArchive *

CreateFileReader ( const TCHAR* Filename,
uint32 ReadFlags
)

 Opens a file for reading and create an FArchive which can be used to read from it.
Public function FArchive *

CreateFileWriter ( const TCHAR* Filename,
uint32 WriteFlags
)

 Opens a file for writing and create an FArchive which can be used to write to it.
Public function bool

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

 Deletes a file.
Public function bool

DeleteDirectory ( const TCHAR* Path,
bool RequireExists,
bool Tree
)

 Deletes a directory.
Public function bool
DirectoryExists

( const TCHAR* InDirectory
)

 Checks if a directory exists.
Public function bool

FileExists ( const TCHAR* Filename
)

 Checks if a file exists
Public function int64

FileSize ( const TCHAR* Filename
)

 Returns the size of a file. (Thread-safe)
Public function void

FindFiles ( TArray< FString >& FileNames,
const TCHAR* Filename,
bool Files,
bool Directories
)

 Finds file or directories.
Public function void

FindFiles ( TArray< FString >& FoundFiles,
const TCHAR* Directory,
const TCHAR* FileExtension
)

 Finds all the files within the given directory, with optional file extension filter.
Public function void

FindFilesRecursive ( TArray< FString >& FileNames,
const TCHAR* StartDirectory,
const TCHAR* Filename,
bool Files,
bool Directories,
bool bClearFileNames
)

 Finds file or directories recursively.
Public function Static IFileManager &

Get ()

 Singleton access, platform specific, also calls PreInit()
Public function FDateTime

GetAccessTimeStamp ( const TCHAR* Filename
)

  
Public function double

GetFileAgeSeconds ( const TCHAR* Filename
)

 Gets the age of a file measured in seconds.
Public function FString

GetFilenameOnDisk ( const TCHAR* Filename
)

 For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem.
Public function FFileStatData

GetStatData ( const TCHAR* FilenameOrDirectory
)

 Return the stat data for the given file or directory.
Public function FDateTime

GetTimeStamp ( const TCHAR* Path
)

  
Public function void

GetTimeStampPair ( const TCHAR* PathA,
const TCHAR* PathB,
FDateTime& OutTimeStampA,
FDateTime& OutTimeStampB
)

  
Public function bool

IsReadOnly ( const TCHAR* Filename
)

 If you're writing to a debug file, you should use CreateDebugFileWriter, and wrap the calling code in if ALLOW_DEBUG_FILES.
Public function Const bool Returns whether the sandbox is enabled or not
Public function bool

IterateDirectory ( const TCHAR* Directory,
IPlatformFile::FDirectoryVisitorFunc Visitor
)

 Call the visitor once for each file or directory in a single directory.
Public function bool

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

 Call the Visit function of the visitor once for each file or directory in a single directory.
Public function bool Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function bool

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

 Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function bool Call the visitor once for each file or directory in a single directory.
Public function bool

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

 Call the Visit function of the visitor once for each file or directory in a single directory.
Public function bool Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function bool Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function bool

MakeDirectory ( const TCHAR* Path,
bool Tree
)

 Creates a directory.
Public function bool

Move ( const TCHAR* Dest,
const TCHAR* Src,
bool Replace,
bool EvenIfReadOnly,
bool Attributes,
bool bDoNotRetryOrError
)

 Moves/renames a file.
Public function void Allow the file manager to handle the commandline
Public function bool Sends a message to the file server, and will block until it's complete.
Public function void

SetSandboxEnabled ( bool bInEnabled
)

 Enables/disables the sandbox, if it is being used
Public function bool

SetTimeStamp ( const TCHAR* Path,
FDateTime TimeStamp
)

 Sets the modification time of the given file

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page