Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


OpenFileAsync(string)

Opens the file asynchronously.
Read time 1 minuteLast updated 10 days ago

Definition

public static FileHandle OpenFileAsync(string fileName)

Parameters

fileName

The path to the file to be opened.

Returns

Type

Description

FileHandleThe FileHandle of the file being opened. Use the FileHandle to check the status of the open operation, to read the file, and to close the file when done.

Remarks

Note: WebGL builds do not support using
AsyncReadManager
to open files from a remote web server; for example, from the path
Application.streamingAssetsPath
which maps to a URL on a remote web server.

Examples

using System.IO;using Unity.IO.LowLevel.Unsafe;using UnityEngine;class AsyncOpenSample : MonoBehaviour{ FileHandle fileHandle; public unsafe void Start() { string filePath = Path.Combine(Application.streamingAssetsPath, "myfile.bin"); fileHandle = AsyncReadManager.OpenFileAsync(filePath); } public unsafe void Update() { if (fileHandle.IsValid() && fileHandle.JobHandle.IsCompleted) { fileHandle.Close().Complete(); } }}