Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > FileCache > IFileCacheHandle > IFileCacheHandle::ReadData

Light Theme

Dark Theme

IFileCacheHandle::ReadData

Read a byte range form the file.

Windows

MacOS

Linux

References

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

Syntax

IMemoryReadStreamRef ReadData
(
    FGraphEventArray & OutCompletionEvents,
    int64 Offset,
    int64 BytesToRead,
    EAsyncIOPriorityAndFlags Priority
)

Remarks

Read a byte range form the file. This can be a high-throughput operation and done lots of times for small reads. The system will handle this efficiently.

Returns

Memory stream that contains the requested range. May return nullptr in rare cases if the request could not be serviced Data read from this stream will not be valid until all events returned in OutCompletionEvents are complete

Parameters

Parameter	Description
OutCompletionEvents	Must wait until these events are complete before returned data is valid

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss