FileExists(string)

grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » FileExists(string)

Version 2.1

Description

The FileExists Lua function checks if a file exists and returns a boolean with the result.

Arguments

String:
The string must include the path and filename for the file that should be checked.

Return

Boolean:
- True / 1: The file exists.
- False / 0: The file does not exist.

Example

This example returns feedback for the first file in the show file folder. The example uses the GetPath() and DirList() functions.

The GetPath Lua function delivers a string with the path of a grandMA3 folder.

Learn more in the GetPath() topic.

The DirList Lua function returns a table of files at a specified path.

Learn more in the DirList() topic.

Copy Code

Lua

return function ()
    -- Get the path to the show files.
    local path = GetPath(Enums.PathType.Showfiles)
    -- Get a table of files at the path.
    local dirTable = DirList(path)
    -- Get the file name for the first file.
    local firstFile = dirTable[1]['name']
    -- Create a string with the path and filename.
    local filepath = string.format("%s%s%s", path, GetPathSeparator(), firstFile)

    -- Check if the file exist and return useful feedback.
    if FileExists(filepath) then
        Printf('The file "' .. firstFile .. '" exist at path "' .. path .. '"')
    else
        Printf('The file "' .. firstFile .. '" does not exist')
    end
end