1. Epic GamesDeveloper
  3. FLoggedPlatformFile

FLoggedPlatformFile

API > API/Runtime > API/Runtime/Core

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

Syntax

class FLoggedPlatformFile : public IPlatformFile

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FLoggedPlatformFile()

   HAL/IPlatformFileLogWrapper.h  

Classes

Name Remarks
FLogStatVisitor  
FLogVisitor  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
LogFileCritical FCriticalSection   HAL/IPlatformFileLogWrapper.h  
LowerLevel IPlatformFile *   HAL/IPlatformFileLogWrapper.h  
OpenHandles TMap< FString, int32 >   HAL/IPlatformFileLogWrapper.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void HandleDumpCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

   HAL/IPlatformFileLogWrapper.h  

void OnHandleClosed ( const FString& Filename
)

   HAL/IPlatformFileLogWrapper.h  

void OnHandleOpen ( const FString& Filename
)

   HAL/IPlatformFileLogWrapper.h  

Overridden from IPlatformFile

Name Remarks Include Path Unreal Specifiers

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

 Copy a file. This will fail if the destination file already exists. HAL/IPlatformFileLogWrapper.h  

virtual bool CreateDirectory ( const TCHAR* Directory
)

 Create a directory and return true if the directory was created or already existed. HAL/IPlatformFileLogWrapper.h  

virtual bool DeleteDirectory ( const TCHAR* Directory
)

 Delete a directory and return true if the directory was deleted or otherwise does not exist. HAL/IPlatformFileLogWrapper.h  

virtual bool DeleteDirectoryRecursively ( const TCHAR* Directory
)

 Delete all files and subdirectories in a directory, then delete the directory itself HAL/IPlatformFileLogWrapper.h  

virtual bool DeleteFile ( const TCHAR* Filename
)

 Delete a file and return true if the file exists. Will not delete read only files. HAL/IPlatformFileLogWrapper.h  

virtual bool DirectoryExists ( const TCHAR* Directory
)

 Return true if the directory exists. HAL/IPlatformFileLogWrapper.h  

virtual bool FileExists ( const TCHAR* Filename
)

 Return true if the file exists. HAL/IPlatformFileLogWrapper.h  

virtual FFileJournalData FileJournalGetFileData ( const TCHAR* FilenameOrDirectory,
FString* OutError
)

 Return the data for the given path as with GetStatData, but report a FFileJournalData instead, which notably includes the FFileJournalFileHandle for the file/directory. HAL/IPlatformFileLogWrapper.h  

virtual EFileJournalResult FileJournalGetLatestEntry ( const TCHAR* VolumeName,
FFileJournalId& OutJournalId,
FFileJournalEntryHandle& OutEntryHandle,
FString* OutError
)

 Report the current end of the journal for the given volume, to be used as the StartingJournalEntry in FileJournalGetModifiedDirectories. HAL/IPlatformFileLogWrapper.h  

virtual uint64 FileJournalGetMaximumSize ( const TCHAR* VolumeOrPath,
ELogVerbosity::Type* OutErrorLevel,
FString* OutError
) const

 Return the maximum size of the FileJournal for the specified VolumeName, if available, zero otherwise. HAL/IPlatformFileLogWrapper.h  

virtual FString FileJournalGetVolumeName ( FStringView InPath
)

 Return the VolumeSpecifier present in the given path. HAL/IPlatformFileLogWrapper.h  

virtual bool FileJournalIsAvailable ( const TCHAR* VolumeOrPath,
ELogVerbosity::Type* OutErrorLevel,
FString* OutError
)

 Return whether FileJournal functionality is available on the current platform if VolumeName is nullptr or for the given Volume if VolumeName is non-null. HAL/IPlatformFileLogWrapper.h  

virtual bool FileJournalIterateDirectory ( const TCHAR* Directory,
FDirectoryJournalVisitorFunc Visitor,
FString* OutError
)

 Iterate the given directory as with IterateDirectoryStat, but report a FFileJournalData for each file and directory, which notably includes the FFileJournalFileHandle for the file/directory. HAL/IPlatformFileLogWrapper.h  

virtual EFileJournalResult FileJournalReadModified ( const TCHAR* VolumeName,
const FFileJournalId& JournalIdOfStartingEntry,
const FFileJournalEntryHandle& StartingJournalEntry,
TMap< FFileJournalFileHandle, FString >& KnownDirectories,
TSet< FString >& OutModifiedDirectories,
FFileJournalEntryHandle& OutNextJournalEntry,
FString* OutError
)

 Query the FileJournal to find a list of all directories on the given volume with files that have been added, deleted, or modified in the specified time range. HAL/IPlatformFileLogWrapper.h  

virtual int64 FileSize ( const TCHAR* Filename
)

 Return the size of the file, or -1 if it doesn't exist. HAL/IPlatformFileLogWrapper.h  

virtual FDateTime GetAccessTimeStamp ( const TCHAR* Filename
)

 Return the last access time of a file. HAL/IPlatformFileLogWrapper.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/IPlatformFileLogWrapper.h  

virtual IPlatformFile * GetLowerLevel()

 Gets the platform file wrapped by this file. HAL/IPlatformFileLogWrapper.h  

virtual const TCHAR * GetName()

 Gets this platform file type name. HAL/IPlatformFileLogWrapper.h  

virtual FFileStatData GetStatData ( const TCHAR* FilenameOrDirectory
)

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

virtual FDateTime GetTimeStamp ( const TCHAR* Filename
)

 Return the modification time of a file. HAL/IPlatformFileLogWrapper.h  

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

 Initializes platform file. HAL/IPlatformFileLogWrapper.h  

virtual bool IsReadOnly ( const TCHAR* Filename
)

 Return true if the file is read only. HAL/IPlatformFileLogWrapper.h  

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

 Call the visitor once for each file or directory in a single directory. HAL/IPlatformFileLogWrapper.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/IPlatformFileLogWrapper.h  

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

 Call the Visit function of the visitor once for each file or directory in a directory tree. HAL/IPlatformFileLogWrapper.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/IPlatformFileLogWrapper.h  

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

 Call the visitor once for each file or directory in a single directory. HAL/IPlatformFileLogWrapper.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/IPlatformFileLogWrapper.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/IPlatformFileLogWrapper.h  

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

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

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

 Attempt to move a file. Return true if successful. Will not overwrite existing files. HAL/IPlatformFileLogWrapper.h  

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

 Open a file for async reading. This call does not hit the disk or block. HAL/IPlatformFileLogWrapper.h  

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

 Open a file for async reading. This call does hit the disk; it is synchronous open. HAL/IPlatformFileLogWrapper.h  

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

 Attempt to open a file for reading. HAL/IPlatformFileLogWrapper.h  

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

 Attempt to open a file for writing. HAL/IPlatformFileLogWrapper.h  

virtual void SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags MinPriority
)

 Controls if the pak precacher should process precache requests. HAL/IPlatformFileLogWrapper.h  

virtual void SetLowerLevel ( IPlatformFile* NewLowerLevel
)

 Sets the platform file wrapped by this file. HAL/IPlatformFileLogWrapper.h  

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

 Attempt to change the read only status of a file. Return true if successful. HAL/IPlatformFileLogWrapper.h  

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

 Sets the modification time of a file HAL/IPlatformFileLogWrapper.h  

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

 Checks if this platform file should be used even though it was not asked to be. HAL/IPlatformFileLogWrapper.h  

Static

Name Remarks Include Path Unreal Specifiers

static const TCHAR * GetTypeName()

   HAL/IPlatformFileLogWrapper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page