FUntypedBulkData::CreateStreamingRequest

Create an async read request for the bulk data.

Windows
MacOS
Linux

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h

Include

#include "Serialization/BulkData.h"

Source

/Engine/Source/Runtime/CoreUObject/Private/Serialization/BulkData.cpp

Syntax

IBulkDataIORequest * CreateStreamingRequest
(
    int64 OffsetInBulkData,
    int64 BytesToRead,
    EAsyncIOPriorityAndFlags Priority,
    FBulkDataIORequestCallBack * CompleteCallback,
    uint8 * UserSuppliedMemory
) const

Remarks

Create an async read request for the bulk data. This version allows the user to request a subset of the data that the FUntypedBulkData represents.

Returns

A request for the read. This is owned by the caller and must be deleted by the caller.

Parameters

Parameter

Description

OffsetInBulkData

Offset into the bulk data to start reading from.

BytesToRead

The number of bytes to read. If this request is AIOP_Preache, the size can be anything, even MAX_int64, otherwise the size and offset must be fully contained in the file.

Priority

Priority and flags of the request. If this includes AIOP_FLAG_PRECACHE, then memory will never be returned. The request should always be canceled and waited for, even for a precache request.

CompleteCallback

Called from an arbitrary thread when the request is complete. Can be nullptr, if non-null, must remain valid until it is called. It will always be called.

UserSuppliedMemory

A pointer to memory for the IO request to be written to, it is up to the caller to make sure that it is large enough. If the pointer is null then the system will allocate memory instead.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss