1. Epic GamesDeveloper
  3. FFileManagerGeneric

FFileManagerGeneric

Base class for file managers.

API > API/Runtime > API/Runtime/Core

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.

   
Name FFileManagerGeneric
Type class
Header File /Engine/Source/Runtime/Core/Public/HAL/FileManagerGeneric.h
Include Path #include "HAL/FileManagerGeneric.h"

Syntax

class FFileManagerGeneric : public IFileManager

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FFileManagerGeneric()

 Default constructor. HAL/FileManagerGeneric.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FFileManagerGeneric()

 Virtual destructor. HAL/FileManagerGeneric.h  

Functions

Public

Overridden from IFileManager

Name Remarks Include Path Unreal Specifiers

virtual FString ConvertToAbsolutePathForExternalAppForRead ( const TCHAR* Filename
)

 Converts passed in filename to use an absolute path (for reading) HAL/FileManagerGeneric.h  

virtual FString ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR* Filename
)

 Converts passed in filename to use an absolute path (for writing) HAL/FileManagerGeneric.h  

virtual FString ConvertToRelativePath ( const TCHAR* Filename
)

 Converts passed in filename to use a relative path. HAL/FileManagerGeneric.h  

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

 Copies a file. HAL/FileManagerGeneric.h  

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. HAL/FileManagerGeneric.h  

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. HAL/FileManagerGeneric.h  

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

 Deletes a file. HAL/FileManagerGeneric.h  

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

 Deletes a directory. HAL/FileManagerGeneric.h  

virtual bool DirectoryExists ( const TCHAR* InDirectory
)

 Checks if a directory exists. HAL/FileManagerGeneric.h  

virtual bool FileExists ( const TCHAR* Filename
)

 Checks if a file exists HAL/FileManagerGeneric.h  

virtual int64 FileSize ( const TCHAR* Filename
)

 Returns the size of a file. (Thread-safe) HAL/FileManagerGeneric.h  

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

 Finds file or directories. HAL/FileManagerGeneric.h  

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. HAL/FileManagerGeneric.h  

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

 Finds file or directories recursively. HAL/FileManagerGeneric.h  

virtual FDateTime GetAccessTimeStamp ( const TCHAR* Filename
)

   HAL/FileManagerGeneric.h  

virtual double GetFileAgeSeconds ( const TCHAR* Filename
)

 Gets the age of a file measured in seconds. HAL/FileManagerGeneric.h  

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. HAL/FileManagerGeneric.h  

virtual FFileStatData GetStatData ( const TCHAR* FilenameOrDirectory
)

 Return the stat data for the given file or directory. HAL/FileManagerGeneric.h  

virtual FDateTime GetTimeStamp ( const TCHAR* Path
)

   HAL/FileManagerGeneric.h  

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

   HAL/FileManagerGeneric.h  

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. HAL/FileManagerGeneric.h  

virtual bool IsSandboxEnabled()

 Returns whether the sandbox is enabled or not HAL/FileManagerGeneric.h  

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

 Call the visitor once for each file or directory in a single directory. HAL/FileManagerGeneric.h  

virtual 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. HAL/FileManagerGeneric.h  

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

 Call the Visit function of the visitor once for each file or directory in a directory tree. HAL/FileManagerGeneric.h  

virtual 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. HAL/FileManagerGeneric.h  

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

 Call the visitor once for each file or directory in a single directory. HAL/FileManagerGeneric.h  

virtual 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. HAL/FileManagerGeneric.h  

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

 Call the Visit function of the visitor once for each file or directory in a directory tree. HAL/FileManagerGeneric.h  

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

 Call the Visit function of the visitor once for each file or directory in a directory tree. HAL/FileManagerGeneric.h  

virtual bool MakeDirectory ( const TCHAR* Path,
bool Tree
)

 Creates a directory. HAL/FileManagerGeneric.h  

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

 Moves/renames a file. HAL/FileManagerGeneric.h  

virtual void ProcessCommandLineOptions()

 Allow the file manager to handle the commandline HAL/FileManagerGeneric.h  

virtual bool SendMessageToServer ( const TCHAR* Message,
IPlatformFile::IFileServerMessageHandler* Handler
)

 Sends a message to the file server, and will block until it's complete. HAL/FileManagerGeneric.h  

virtual void SetSandboxEnabled ( bool bInEnabled
)

 Enables/disables the sandbox, if it is being used HAL/FileManagerGeneric.h  

virtual bool SetTimeStamp ( const TCHAR* Path,
FDateTime TimeStamp
)

 Sets the modification time of the given file HAL/FileManagerGeneric.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString DefaultConvertToRelativePath ( const TCHAR* Filename
)

 Converts passed in filename to use a relative path. HAL/FileManagerGeneric.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page