Navigation
API > API/Runtime > API/Runtime/Core
File handle interface.
| Name | IFileHandle |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformFile.h |
| Include Path | #include "GenericPlatform/GenericPlatformFile.h" |
Syntax
class IFileHandle
Derived Classes
IFileHandle derived class hierarchy
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IFileHandle() |
Destructor, also the only way to close the file handle | GenericPlatform/GenericPlatformFile.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Flush
(
const bool bFullFlush |
Flushes file handle to disk. | GenericPlatform/GenericPlatformFile.h | |
bool Read
(
uint8* Destination, |
Read bytes from the file. | GenericPlatform/GenericPlatformFile.h | |
bool ReadAt
(
uint8* Destination, |
GenericPlatform/GenericPlatformFile.h | ||
bool Seek
(
int64 NewPosition |
Change the current write or read position. | GenericPlatform/GenericPlatformFile.h | |
bool SeekFromEnd
(
int64 NewPositionRelativeToEnd |
Change the current write or read position, relative to the end of the file. | GenericPlatform/GenericPlatformFile.h | |
virtual void ShrinkBuffers() |
Minimizes optional system or process cache kept for the file. | GenericPlatform/GenericPlatformFile.h | |
virtual int64 Size() |
Return the total size of the file | GenericPlatform/GenericPlatformFile.h | |
int64 Tell() |
Return the current write or read position. | GenericPlatform/GenericPlatformFile.h | |
bool Truncate
(
int64 NewSize |
Truncate the file to the given size (in bytes). | GenericPlatform/GenericPlatformFile.h | |
bool Write
(
const uint8* Source, |
Write bytes to the file. | GenericPlatform/GenericPlatformFile.h |