Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > HAL > FFileManagerGeneric

Light Theme

Dark Theme

FFileManagerGeneric

Base class for file managers.

Windows

MacOS

Linux

Inheritance Hierarchy

IFileManager

FFileManagerGeneric

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

	Name	Description
	FFileManagerGeneric()	Default constructor.

Destructors

	Name	Description
	~FFileManagerGeneric()	Virtual destructor.

Functions

		Name	Description
	FString	DefaultConvertToRelativePath ( const TCHAR* Filename )	Converts passed in filename to use a relative path.

Overridden from IFileManager

	Name	Description
FString	ConvertToAbsolutePathForExternalAppForRead ( const TCHAR* Filename )	Converts passed in filename to use an absolute path (for reading)
FString	ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR* Filename )	Converts passed in filename to use an absolute path (for writing)
FString	ConvertToRelativePath ( const TCHAR* Filename )	Converts passed in filename to use a relative path.
uint32	Copy ( const TCHAR* Dest, const TCHAR* Src, bool Replace, bool EvenIfReadOnly, bool Attributes, FCopyProgress* Progress, EFileRead ReadFlags, EFileWrite WriteFlags )	Copies a file.
FArchive ...	CreateFileReader ( const TCHAR* Filename, uint32 ReadFlags )	Creates file reader archive.
FArchive ...	CreateFileWriter ( const TCHAR* Filename, uint32 WriteFlags )	Creates file writer archive.
bool	Delete ( const TCHAR* Filename, bool RequireExists, bool EvenReadOnly, bool Quiet )	Deletes a file.
bool	DeleteDirectory ( const TCHAR* Path, bool RequireExists, bool Tree )	Deletes a directory.
bool	DirectoryExists ( const TCHAR* InDirectory )	Checks if a directory exists.
bool	FileExists ( const TCHAR* Filename )	Checks if a file exists
int64	FileSize ( const TCHAR* Filename )	Returns the size of a file. (Thread-safe)
void	FindFiles ( TArray< FString >& FileNames, const TCHAR* Filename, bool Files, bool Directories )	Finds file or directories.
void	FindFiles ( TArray< FString >& FoundFiles, const TCHAR* Directory, const TCHAR* FileExtension )	Finds all the files within the given directory, with optional file extension filter.
void	FindFilesRecursive ( TArray< FString >& FileNames, const TCHAR* StartDirectory, const TCHAR* Filename, bool Files, bool Directories, bool bClearFileNames )	Finds file or directories recursively.
FDateTime	GetAccessTimeStamp ( const TCHAR* Filename )
double	GetFileAgeSeconds ( const TCHAR* Filename )	Gets the age of a file measured in seconds.
FString	GetFilenameOnDisk ( const TCHAR* Filename )	For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem.
FFileStatDat...	GetStatData ( const TCHAR* FilenameOrDirecto... )	Return the stat data for the given file or directory.
FDateTime	GetTimeStamp ( const TCHAR* Path )
void	GetTimeStampPair ( const TCHAR* PathA, const TCHAR* PathB, FDateTime& OutTimeStampA, FDateTime& OutTimeStampB )
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.
bool	IsSandboxEnabled()	Returns whether the sandbox is enabled or not
bool	IterateDirectory ( const TCHAR* Directory, IPlatformFile::FDirectoryVisitorFun... )	Call the visitor once for each file or directory in a single directory.
bool	IterateDirectory ( const TCHAR* Directory, IPlatformFile::FDirectoryVisitor& ... )	Call the Visit function of the visitor once for each file or directory in a single directory.
bool	IterateDirectoryRecursively ( const TCHAR* Directory, IPlatformFile::FDirectoryVisitorFun... )	Call the Visit function of the visitor once for each file or directory in a directory tree.
bool	IterateDirectoryRecursively ( const TCHAR* Directory, IPlatformFile::FDirectoryVisitor& ... )	Call the Visit function of the visitor once for each file or directory in a directory tree.
bool	IterateDirectoryStat ( const TCHAR* Directory, IPlatformFile::FDirectoryStatVisito... )	Call the visitor once for each file or directory in a single directory.
bool	IterateDirectoryStat ( const TCHAR* Directory, IPlatformFile::FDirectoryStatVisito... )	Call the Visit function of the visitor once for each file or directory in a single directory.
bool	IterateDirectoryStatRecursively ( const TCHAR* Directory, IPlatformFile::FDirectoryStatVisito... )	Call the Visit function of the visitor once for each file or directory in a directory tree.
bool	IterateDirectoryStatRecursively ( const TCHAR* Directory, IPlatformFile::FDirectoryStatVisito... )	Call the Visit function of the visitor once for each file or directory in a directory tree.
bool	MakeDirectory ( const TCHAR* Path, bool Tree )	Creates a directory.
bool	Move ( const TCHAR* Dest, const TCHAR* Src, bool Replace, bool EvenIfReadOnly, bool Attributes, bool bDoNotRetryOrError )	Moves/renames a file.
void	ProcessCommandLineOptions()	Allow the file manager to handle the commandline
bool	SendMessageToServer ( const TCHAR* Message, IPlatformFile::IFileServerMessageHa... )	Sends a message to the file server, and will block until it's complete.
void	SetSandboxEnabled ( bool bInEnabled )	Enables/disables the sandbox, if it is being used
bool	SetTimeStamp ( const TCHAR* Path, FDateTime TimeStamp )	Sets the modification time of the given file

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss