EngineGetFileSystemItemAsync Method

public abstract Task<IFileSystemItem> GetFileSystemItemAsync(
	string userFileSystemPath,
	FileSystemItemType itemType,
	byte[] itemId = null
)

Public MustOverride Function GetFileSystemItemAsync ( 
	userFileSystemPath As String,
	itemType As FileSystemItemType,
	Optional itemId As Byte() = Nothing
) As Task(Of IFileSystemItem)

public:
virtual Task<IFileSystemItem^>^ GetFileSystemItemAsync(
	String^ userFileSystemPath, 
	FileSystemItemType itemType, 
	array<unsigned char>^ itemId = nullptr
) abstract

abstract GetFileSystemItemAsync : 
        userFileSystemPath : string * 
        itemType : FileSystemItemType * 
        ?itemId : byte[] 
(* Defaults:
        let _itemId = defaultArg itemId null
*)
-> Task<IFileSystemItem> 

Parameters

userFileSystemPath

Type: SystemString
Path in the user file system for which your will return a file or a folder.

itemType

Type: ITHit.FileSystemFileSystemItemType
Item type - file or folder.

itemId (Optional)

Type: SystemByte
Item ID or null for root folder or if the remote storage did not provide item ID. See ItemId description for more details.

Return Value

Implements

This is a factory method that returns file and folder items. In your implementation you will return file or folder item that corresponds to the provided userFileSystemPath or itemId parameters. Your file must implement IFile interface. Your folder must implement IFolder interface.

The Engine will then call IFile and IFolder methods to execute operations requested by the platform.

Note that this method may be called for files that does not exist in the user file system, for example when a file handle is closed after the file has been deleted.

In case of macOS platform, there is no access to the local file system. You should NOT try to determine item type or read local files/folders on macOS.

The code below is part of 'VirtualFileSystem' C# sample provided with the SDK.

public override async Task<IFileSystemItem> GetFileSystemItemAsync(string path)
{
    if(File.Exists(path))
    {
        return new VfsFile(path, this, this);
    }
    if(Directory.Exists(path))
    {
        return new VfsFolder(path, this, this);
    }

    // When a file handle is being closed during delete, the file does not exist, return null.
    return null; 
}

Reference