1. Epic GamesDeveloper
  3. FFileManagerGeneric

FFileManagerGeneric

Base class for file managers.

Unreal Engine C++ API Reference > Runtime > Core > HAL

Inheritance Hierarchy

References

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

Syntax

class FFileManagerGeneric : public IFileManager

Remarks

Base class for file managers.

This base class simplifies IFileManager implementations by providing simple, unoptimized implementations of functions whose implementations can be derived from other functions.

Constructors

  Type Name Description
Public function   Default constructor.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Static FString

DefaultConvertToRelativePath ( const TCHAR* Filename
)

 Converts passed in filename to use a relative path.

Overridden from IFileManager

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

ConvertToRelativePath ( const TCHAR* Filename
)

 Converts passed in filename to use a relative path.
Public function Virtual 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 Virtual 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 Virtual 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 Virtual bool

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

 Deletes a file.
Public function Virtual bool

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

 Deletes a directory.
Public function Virtual bool
DirectoryExists

( const TCHAR* InDirectory
)

 Checks if a directory exists.
Public function Virtual bool

FileExists ( const TCHAR* Filename
)

 Checks if a file exists
Public function Virtual int64

FileSize ( const TCHAR* Filename
)

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

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

 Finds file or directories.
Public function Virtual 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 Virtual void

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

 Finds file or directories recursively.
Public function Virtual FDateTime

GetAccessTimeStamp ( const TCHAR* Filename
)

  
Public function Virtual double

GetFileAgeSeconds ( const TCHAR* Filename
)

 Gets the age of a file measured in seconds.
Public function Virtual 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 Virtual FFileStatData

GetStatData ( const TCHAR* FilenameOrDirectory
)

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

GetTimeStamp ( const TCHAR* Path
)

  
Public function Virtual void

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

  
Public function Virtual 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 Virtual Const bool Returns whether the sandbox is enabled or not
Public function Virtual bool Call the visitor once for each file or directory in a single directory.
Public function Virtual bool Call the Visit function of the visitor once for each file or directory in a single directory.
Public function Virtual bool Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function Virtual bool Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function Virtual bool Call the visitor once for each file or directory in a single directory.
Public function Virtual bool Call the Visit function of the visitor once for each file or directory in a single directory.
Public function Virtual bool Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function Virtual bool Call the Visit function of the visitor once for each file or directory in a directory tree.
Public function Virtual bool

MakeDirectory ( const TCHAR* Path,
bool Tree
)

 Creates a directory.
Public function Virtual bool

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

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

SetSandboxEnabled ( bool bInEnabled
)

 Enables/disables the sandbox, if it is being used
Public function Virtual 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