UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FUnixMappedFileHandle Class Referencefinal
+ Inheritance diagram for FUnixMappedFileHandle:

Public Member Functions

 FUnixMappedFileHandle (int InFileHandle, int64 FileSize, const FString &InFilename)
 
virtual ~FUnixMappedFileHandle () override
 
virtual IMappedFileRegion * MapRegion (int64 Offset=0, int64 BytesToMap=MAX_int64, FFileMappingFlags Flags=EMappedFileFlags::ENone) override
 
void UnMap (const FUnixMappedFileRegion *Region)
 
- Public Member Functions inherited from IMappedFileHandle
 IMappedFileHandle (size_t InFileSize)
 
virtual ~IMappedFileHandle ()
 
UE_FORCEINLINE_HINT int64 GetFileSize () const
 
virtual void Flush (void)
 
 IMappedFileHandle (const IMappedFileHandle &)=delete
 
IMappedFileHandle & operator= (const IMappedFileHandle &)=delete
 

Constructor & Destructor Documentation

◆ FUnixMappedFileHandle()

FUnixMappedFileHandle::FUnixMappedFileHandle ( int  InFileHandle,
int64  FileSize,
const FString &  InFilename 
)
inline

◆ ~FUnixMappedFileHandle()

virtual FUnixMappedFileHandle::~FUnixMappedFileHandle ( )
inlineoverridevirtual

Member Function Documentation

◆ MapRegion()

virtual IMappedFileRegion * FUnixMappedFileHandle::MapRegion ( int64  Offset = 0,
int64  BytesToMap = MAX_int64,
FFileMappingFlags  Flags = EMappedFileFlags::ENone 
)
inlineoverridevirtual

Map a region of the file.

Parameters
OffsetOffset into the file to start mapping.
BytesToMapNumber of bytes to map. Clamped to the size of the file.
FlagsA combination of EMappingFlags values
Returns
the mapped region interface. Returns nullptr on failure.

Implements IMappedFileHandle.

◆ UnMap()

void FUnixMappedFileHandle::UnMap ( const FUnixMappedFileRegion *  Region)
inline
The documentation for this class was generated from the following file: