MemoryMappedFileStream::create

Factory method for creation of a [MemoryMappedFileStream](API\Plugins\RigLogicLib\trio\streams\MemoryMappedFileStream) instance.

Windows
MacOS
Linux

Warnings

  • User is responsible for releasing the returned pointer by calling destroy.

References

Module

RigLogicLib

Header

/Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Public/trio/streams/MemoryMappedFileStream.h

Include

#include "trio/streams/MemoryMappedFileStream.h"

Source

/Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Private/trio/streams/MemoryMappedFileStream.cpp

Syntax

static MemoryMappedFileStream * create
(
    const char * path,
    AccessMode accessMode,
    MemoryResource * memRes
)

Remarks

User is responsible for releasing the returned pointer by calling destroy.

Parameters

Parameter

Description

path

UTF-8 encoded path to file to be opened.

accessMode

Control whether the file is opened for reading or writing.

memRes

The memory resource to be used for the allocation of the MemoryMappedFileStream instance. @note If a custom memory resource is not given, a default allocation mechanism will be used.

See Also

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