IFileHandle

File handle interface.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformFile.h

Include

#include "GenericPlatform/GenericPlatformFile.h"

Syntax

class IFileHandle

Remarks

File handle interface.

Destructors

Name Description

Public function Virtual

~IFileHandle()

Destructor, also the only way to close the file handle

Functions

Name Description

Public function

bool

 

Flush

(
    const bool bFullFlush
)

Flushes file handle to disk.

Public function

bool

 

Read

(
    uint8* Destination,
    int64 BytesToRead
)

Read bytes from the file.

Public function

bool

 

Seek

(
    int64 NewPosition
)

Change the current write or read position.

Public function

bool

 

SeekFromEnd

(
    int64 NewPositionRelativeToEnd
)

Change the current write or read position, relative to the end of the file.

Public function Virtual

void

 

ShrinkBuffers()

Minimizes optional system or process cache kept for the file.

Public function Virtual

int64

 

Size()

Return the total size of the file

Public function

int64

 

Tell()

Return the current write or read position.

Public function

bool

 

Truncate

(
    int64 NewSize
)

Truncate the file to the given size (in bytes).

Public function

bool

 

Write

(
    const uint8* Source,
    int64 BytesToWrite
)

Write bytes to the 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