IAsyncReadFileHandle

Windows
MacOS
Linux

Inheritance Hierarchy

IAsyncReadFileHandle

FLoggingAsyncReadFileHandle

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Async/AsyncFileHandle.h

Include

#include "Async/AsyncFileHandle.h"

Syntax

class IAsyncReadFileHandle

Constructors

Name Description

Public function

IAsyncReadFileHandle()

Public function

IAsyncReadFileHandle

(
    const IAsyncReadFileHandle &
)

Non-copyable.

Destructors

Name Description

Public function Virtual

~IAsyncReadFileHandle()

Destructor, also the only way to close the file handle.

Functions

Name Description

Public function

IAsyncReadRe ...

 

ReadRequest

(
    int64 Offset,
    int64 BytesToRead,
    EAsyncIOPriorityAndFlags PriorityAn...,
    FAsyncFileCallBack * CompleteCa...,
    uint8 * UserSuppliedMemory
)

Submit an async request and/or wait for an async request

Public function

IAsyncReadRe ...

 

SizeRequest

(
    FAsyncFileCallBack * CompleteCa...
)

Request the size of the file. This is also essentially the existence check.

Public function Virtual

bool

 

UsesCache()

Return true if this file is backed by a cache, if not, then precache requests are ignored.

Operators

Name Description

Public function

IAsyncReadFi ...

 

operator=

(
    const IAsyncReadFileHandle &
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback