FLuminPlatformFile

File I/O implementation

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Lumin/LuminPlatformFile.h

Include

#include "Lumin/LuminPlatformFile.h"

Syntax

class FLuminPlatformFile : public IPhysicalPlatformFile

Remarks

File I/O implementation

Variables

Name Description

Protected variable

bool

 

bIsSandboxEnabled

Functions

Name Description

Public function Const

FString

 

ConvertToLuminPath

(
    const FString& Filename,
    bool bForWrite
)

Public function

bool

 

CreateDirectoriesFromPath

(
    const TCHAR* Path
)

Public function

bool

 

FileExistsWithPath

(
    const TCHAR* Filename,
    FString& OutLuminPath
)

Public function

IFileHandle ...

 

GetFileHandleForMLFileInfo

(
    const void* FileInfo
)

Protected function

bool

 

IterateDirectoryCommon

(
    const TCHAR* Directory,
    const TFunctionRef< bool(struct dir...
)

Protected function Virtual

FString

 

NormalizeDirectory

(
    const TCHAR* Directory
)

Protected function Virtual

FString

 

NormalizeFilename

(
    const TCHAR* Filename
)

Lumin File I/O implementation

Public function

bool

 

SetMLFileInfoFD

(
    const IFileHandle* FileHandle,
    void* FileInfo
)

Public function

IFileHandle ...

 

SharedFileOpenRead

(
    const TCHAR* Filename
)

Return a IFileHandle pointer to read the user shared file (file descriptor recieved from ml_sharedfile api).

Public function

IFileHandle ...

 

SharedFileOpenWrite

(
    const TCHAR* Filename
)

Return a IFileHandle pointer to write the user shared file (file descriptor recieved from ml_sharedfile api)..

Overridden from IPlatformFile

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

 

ConvertToAbsolutePathForExternalAppForWrite

(
    const TCHAR* Filename
)

Converts passed in filename to use an absolute path (for writing)

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

 

DeleteDirectory

(
    const TCHAR* Directory
)

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

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

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

FFileStatDat...

 

GetStatData

(
    const TCHAR* FilenameOrDirecto...
)

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

 

IsReadOnly

(
    const TCHAR* Filename
)

Return true if the file is read only.

Public function Virtual Const

bool

 

IsSandboxEnabled()

Returns whether sandboxing is enabled or disabled.

Public function Virtual

bool

 

IterateDirectory

(
    const TCHAR* Directory,
    FDirectoryVisitor& Visitor
)

Call the Visit function of the visitor once for each file or directory in a single directory.

Public function Virtual

bool

 

IterateDirectoryStat

(
    const TCHAR* Directory,
    FDirectoryStatVisitor& Visitor
)

Call the Visit function of the visitor once for each file or directory in a single directory.

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

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

 

SetReadOnly

(
    const TCHAR* Filename,
    bool bNewReadOnlyValue
)

Attempt to change the read only status of a file. Return true if successful.

Public function Virtual

void

 

SetSandboxEnabled

(
    bool bInEnabled
)

Enables/disables application sandbox jail.

Public function Virtual

void

 

SetTimeStamp

(
    const TCHAR* Filename,
    const FDateTime DateTime
)

Sets the modification time of a 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