CloseUndo(handle)

grandMA3 ユーザマニュアル » プラグイン » Lua 関数 - Object-Free API » CloseUndo(handle)

Version 2.2

説明

CloseUndo 関数は、開いているアンドゥ・リストを閉じます。この関数は、処理が成功したかどうかを表す boolean 値を返します。

閉じるアンドゥ・リストは、あらかじめ作成されている必要があります。詳しくは CreateUndo を参照してください。

引数

handle:
作成されたアンドゥ・リストのハンドル。

戻り値

boolean:
- true: アンドゥ・リストは閉じられました。
- false: アンドゥ・リストは使用中のため、閉じることができません。

例

アンドゥ・リストを作成し、リストに追加される一連のコマンドを実行してからリストを閉じます。これによって、一連のコマンドを Oops コマンド1つで取り消せるようになります。

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 == false then
        ErrPrintf("The CloseUndo was not successful")
    elseif closeSuccess == true then
        Printf("The CloseUndo was successful")
    else
        Printf("The CloseUndo did not return a meaningful result")
    end
end