![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The file access interface.
The file interface provides file access for locations on the target system specified by a IEnums::FileCategory.
Check if a file exists.
Boolean FileExists(String name, Murl.IEnums.FileCategory category)
name | The name of the file. |
category | The category where the file reside. |
Check if a folder exists.
Boolean FolderExists(String name, Murl.IEnums.FileCategory category)
name | The name of the folder. |
category | The category where the folder reside. |
Get the absolute file name.
Boolean, String GetAbsoluteName(String relativeName, Murl.IEnums.FileCategory category, String absoluteName)
relativeName | The name of the file. |
category | The category where the file reside. |
absoluteName | The absolute file name return value. |
Get all file names inside a folder.
Boolean, Murl.Array.String GetAllFileNames(String relativePath, Murl.IEnums.FileCategory category, Murl.Array.String names)
relativePath | The name of the folder. |
category | The category where the folder reside. |
names | The array of file names return value. |
Get all folder names inside a folder.
Boolean, Murl.Array.String GetAllFolderNames(String relativePath, Murl.IEnums.FileCategory category, Murl.Array.String names)
relativePath | The name of the folder. |
category | The category where the folder reside. |
names | The array of folder names return value. |
Open a file.
Murl.IFile OpenFile(String name, Murl.IEnums.FileCategory category, Murl.IEnums.FileAccessMode mode, Boolean createFolders)
name | The name of the file. |
category | The category where the file reside. |
mode | The access mode for the file to open. |
createFolders | Create the folders constained in file name if the folders do not exist. |
Close a file.
Boolean, Murl.IFile CloseFile(Murl.IFile handle)
handle | A reference to the file interface to close. After destruction the pointer is set to null. |
Memory-map a read-only file.
Boolean, Murl.ConstData MapFileData(String name, Murl.IEnums.FileCategory category, Murl.ConstData data)
name | The name of the file. |
category | The category where the file reside. |
data | The file data object return value. |
Unmap a memory mapped file.
Boolean, Murl.ConstData UnmapFileData(Murl.ConstData data)
data | The file data object to the memory mapped file. After unmapping the data object is empty. |