IPlatformFile::OpenMapped

Open a file for async reading. This call does hit the disk; it is synchronous open.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

IPlatformFile::OpenMapped()

	FSandboxPlatformFile::OpenMapped()
	FPlatformFileOpenLog::OpenMapped()
	FCachedReadPlatformFile::OpenMapped()
	FLoggedPlatformFile::OpenMapped()
	FPakPlatformFile::OpenMapped()

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformFile.h
Include	#include "GenericPlatform/GenericPlatformFile.h"

Syntax

virtual IMappedFileHandle * OpenMapped
(
const TCHAR * Filename
)

Remarks

Open a file for async reading. This call does hit the disk; it is synchronous open.

Returns

Close the file by delete'ing the handle. A non-null return value does mean the file exists. Null can be returned for many reasons even if the file exists. Perhaps this platform does not support mapped files, or this file is compressed in a pak file. Generally you attempt to open mapped, and if that fails, then use other file operations instead.

Parameters

Parameter	Description
Filename	file to be mapped. This doesn't actually map anything, just opens the file.