FArchiveProxy::Precache

Hint the archive that the region starting at passed in offset and spanning the passed in size is going to be read soon and should be precached.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

FArchive::Precache()

FArchiveProxy::Precache()

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Serialization/ArchiveProxy.h

Include

#include "Serialization/ArchiveProxy.h"

Syntax

virtual bool Precache
(
    int64 PrecacheOffset,
    int64 PrecacheSize
)

Remarks

Hint the archive that the region starting at passed in offset and spanning the passed in size is going to be read soon and should be precached.

The function returns whether the precache operation has completed or not which is an important hint for code knowing that it deals with potential async I/O. The archive is free to either not implement this function or only partially precache so it is required that given sufficient time the function will return true. Archives not based on async I/O should always return true.

This function will not change the current archive position.

Returns

false if precache operation is still pending, true otherwise

Parameters

Parameter

Description

PrecacheOffset

Offset at which to begin precaching.

PrecacheSize

Number of bytes to precache