Version: 2021.2
LanguageEnglish
  • C#

VirtualFileSystem.GetLocalFileSystemName

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static bool GetLocalFileSystemName(string vfsFileName, out string localFileName, out ulong localFileOffset, out ulong localFileSize);

Parameters

vfsFileName Virtual file entry to find.
localFileName Out parameter containing the file on the local filesystem.
localFileOffset Out parameter containing the offset inside of file on the local filesystem.
localFileSize Out parameter containing the size inside of file on the local filesystem.

Returns

bool Details were successfully found.

Description

This method looks up the virtual file entry specified, and returns the details of that file within the file on the local filesystem.

It populates the localFileName, localFileOffset, and localFileSize parameters with the path of the file on the local filesystem that contains the virtual file, and the offset and size of the virtual file within it. This method returns true if the details were successfully found. It returns false if it was not possible. This can happen if the virtual file is contained in a memory filesystem, or in a compressed file.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2022 Unity Technologies. Publication Date: 2022-04-04.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information