Import(handle, string, string)

Description

The Import object Lua function imports an object written in XML format.

	Restriction:
	The imported files need to exist already to be imported.

	Important:
	The Lua import will merge the content of the XML file into the object without any confirmation pop-up.

Arguments

• Handle:
  The function takes a handle of the type “light_userdata” as an argument.
  It can be omitted when using the colon notation on an object.

  The Colon Notation is a way to omit the handle as the first argument when using the Object functions.

  This is the general syntax with the colon notation: object:function()

  This is the general syntax with standard handle notation: object.function(object)

  Learn more in the Lua Functions - Object API topic.

• String:
  This is a string with the path to the file location.

• String:
  This is a string containing the file name of the desired file.

Return

• Boolean:
  The function returns a boolean indicating if the import was a success.

Example

This example imports the content of an XML file into the selected sequence. The file is called “MySelectedSequence”, and it is located at ”../gma3_library/datapools/sequences”. The file can be created using the example in the Export object function.

Copy CodeLua
```
return function()

--SelectedSequence() creates a handle to the selected sequence.
-- The imported object will be merged into this sequence.
local selectedSequence = SelectedSequence()
-- Check if there is a selected sequence - if not then exit the function.
if selectedSequence == nil then
    ErrPrintf("The selected sequence could not be found.")
    return
end
--The path is stored in a variable.
local path = GetPath(Enums.PathType.UserSequences)
--The actual import function.
local success = selectedSequence:Import(path, "mySelectedSequence.xml")
--Print some feedback.
if success then
    Printf("The sequence is imported from: " .. path .. GetPathSeparator() .. "mySelectedSequence.xml")
else
    ErrPrintf("The object could not be imported.")
end

end

## Related Object Function

[Export](/grandma3/2-4/lua_object_export/) - object function used to export an XML table.