1. Epic GamesDeveloper
  3. FCachedReadPlatformFile

FCachedReadPlatformFile

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

Inheritance Hierarchy

References

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

Syntax

class FCachedReadPlatformFile : public IPlatformFile

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static const TCHAR *  

Overridden from IPlatformFile

  Type Name Description
Public function Virtual FString

ConvertToAbsolutePathForExternalAppForRead ( const TCHAR* Filename
)

 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 bool

CopyDirectoryTree ( const TCHAR* DestinationDirectory,
const TCHAR* Source,
bool bOverwriteAllExisting
)

 Copy a file or a hierarchy of files (directory).
Public function 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.
Public function Virtual bool

CreateDirectory ( const TCHAR* Directory
)

 Create a directory and return true if the directory was created or already existed.
Public function Virtual bool

CreateDirectoryTree ( const TCHAR* Directory
)

 Create a directory, including any parent directories and return true if the directory was created or already existed.
Public function Virtual bool

DeleteDirectory ( const TCHAR* Directory
)

 Delete a directory and return true if the directory was deleted or otherwise does not exist.
Public function Virtual bool

DeleteDirectoryRecursively ( const TCHAR* Directory
)

 Delete all files and subdirectories in a directory, then delete the directory itself
Public function Virtual bool

DeleteFile ( const TCHAR* Filename
)

 Delete a file and return true if the file exists. Will not delete read only files.
Public function Virtual bool
DirectoryExists

( const TCHAR* Directory
)

 Return true if the directory exists.
Public function Virtual bool

FileExists ( const TCHAR* Filename
)

 Return true if the file exists.
Public function Virtual int64

FileSize ( const TCHAR* Filename
)

 Return the size of the file, or -1 if it doesn't exist.
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

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

 Finds all the files within the directory tree, with optional file extension filter
Public function Virtual FDateTime

GetAccessTimeStamp ( const TCHAR* Filename
)

 Return the last access time of a file.
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 IPlatformFile * Gets the platform file wrapped by this file.
Public function Virtual Const const TCHAR *

GetName ()

 Gets this platform file type name.
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* Filename
)

 Return the modification time of a file.
Public function Virtual bool

Initialize ( IPlatformFile* Inner,
const TCHAR* CmdLine
)

 Initializes platform file.
Public function Virtual bool

IsReadOnly ( const TCHAR* Filename
)

 Return true if the file is read only.
Public function 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.
Public function 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.
Public function 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.
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

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

 Attempt to move a file. Return true if successful. Will not overwrite existing files.
Public function Virtual IAsyncReadFileHandle *

OpenAsyncRead ( const TCHAR* Filename
)

 Open a file for async reading. This call does not hit the disk or block.
Public function Virtual IMappedFileHandle *

OpenMapped ( const TCHAR* Filename
)

 Open a file for async reading. This call does hit the disk; it is synchronous open.
Public function Virtual IFileHandle *

OpenRead ( const TCHAR* Filename,
bool bAllowWrite
)

 Attempt to open a file for reading.
Public function Virtual IFileHandle *

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

 Attempt to open a file for writing.
Public function Virtual bool

SendMessageToServer ( const TCHAR* Message,
IFileServerMessageHandler* Handler
)

 Sends a message to the file server, and will block until it's complete.
Public function Virtual void

SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags MinPriority
)

 Controls if the pak precacher should process precache requests.
Public function Virtual void

SetLowerLevel ( IPlatformFile* NewLowerLevel
)

 Sets the platform file wrapped by this file.
Public function Virtual bool

SetReadOnly ( const TCHAR* Filename,
bool bNewReadOnlyValue
)

 Attempt to change the read only status of a file. Return true if successful.
Public function Virtual void

SetTimeStamp ( const TCHAR* Filename,
FDateTime DateTime
)

 Sets the modification time of a file
Public function Virtual Const bool

ShouldBeUsed ( IPlatformFile* Inner,
const TCHAR* CmdLine
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page