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

Light Theme

Dark Theme

IAsyncReadRequest

Windows

MacOS

Linux

References

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

Syntax

class IAsyncReadRequest

Variables

		Name	Description
	union IAsyncRea...	@53
	bool	bCanceled
	bool	bCompleteAndCallbackCalled
	bool	bCompleteSync
	bool	bDataIsReady
	const bool	bSizeRequest
	const bool	bUserSuppliedMemory
	FAsyncFileCallB...	Callback
	uint8 *	Memory
	PTRINT	Size

Constructors

	Name	Description
	IAsyncReadRequest ( FAsyncFileCallBack* InCallback, bool bInSizeRequest, uint8* UserSuppliedMemory )

Destructors

	Name	Description
	~IAsyncReadRequest()	Not legal to destroy the request until it is complete.

Functions

	Name	Description
void	Cancel()	Cancel the request. This is a non-blocking async call and so does not ensure completion!
void	CancelImpl()	Cancel the request. This is a non-blocking async call and so does not ensure completion!
uint8 *	GetReadResults()	Return the bytes of a completed read request. Not legal to call unless the request is complete.
int64	GetSizeResults()	Return the size of a completed size request. Not legal to call unless the request is complete.
bool	PollCompletion()	Nonblocking poll of the state of completion.
void	SetAllComplete()
void	SetComplete()
void	SetDataComplete()
bool	WaitCompletion ( float TimeLimitSeconds )	Waits for the request to complete, but not longer than the given time limit
void	WaitCompletionImpl ( float TimeLimitSeconds )	Waits for the request to complete, but not longer than the given time limit

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

Take our survey

Dismiss