CloseUndo(handle)

grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » CloseUndo(handle)

Version 2.0

Description

The CloseUndo Lua function closes an open undo list. The function returns a boolean indicating if the function succeeds.

Undo lists need to be created to be closed. See more about this in the CreateUndo function.

Arguments

Handle:
The handle of a created undo list.

Return

Boolean:
- True / 1: The undo list was closed.
- False / 0: The undo list is still in use and cannot be closed.

Example

This example creates an undo list, performs a series of commands that are added to the undo list, and closes the undo list. Now the series of commands can be oopsed with one oops command.

Copy Code

Lua

return function()
    --Create the undo object 
    local MyNewUndo = CreateUndo("MySelection")
    --Create command actions connected to the undo object
    Cmd("ClearAll", MyNewUndo)
    Cmd("Fixture 1", MyNewUndo)
    Cmd("Fixture 2", MyNewUndo)
    Cmd("Fixture 5", MyNewUndo)
    Cmd("Fixture 7", MyNewUndo)
    --Close the undo group and store it's return in a variable
    local closeSuccess = CloseUndo(MyNewUndo)     
    --Print the feedback from the closing action - 1 = Success / 0 = Failure.
    if closeSuccess == 0 then
        ErrPrintf("The CloseUndo was not successful")
    elseif closeSuccess == 1 then
        Printf("The CloseUndo was successful")
    else
        Printf("The CloseUndo did not return a meaningful result")
    end
end