grandMA3 User Manual Publication
Export(filename, export_data)

grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » Export(filename, export_data)
Version 2.2

Description

The object-free Export Lua function exports a Lua table in XML format.

This Lua function correlates with the Import Lua function.

There is a related object version of Export.

Arguments

  • Filename:
    This is a string containing the file name of the exported file. It should contain the file name, including the entire path. See the example below.
  • Export_data:
    This is the data that is going to be exported. It should be a table object.

Return

  • Boolean:
    This function returns a boolean.
    • True:
      The export was a success
    • False:
      The export failed.

Example

To export the build details table, create a plugin with this code:

Copy Code
Lua
return function()
    -- 'BuildDetails()' creates a table with information about the software build.
    local build = BuildDetails()
    --The path and filename is stored in a variable.
    local exportPath = GetPath(Enums.PathType.Library) .. "/BuildDetails.xml"
    --The actual export (in xml format) using the path and the table - the result boolean stored in a variable.
    local success = Export(exportPath, build)
    --Print feedback about the export path.
    if success then
        Printf("The export was stored at: " .. exportPath)
    else
        Printf("The export failed")
    end
end