CloseUndo(handle)

説明

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

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

引数

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

戻り値

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

例

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

local function main()
    local MyNewUndo = CreateUndo("MySelection")   -- Creation of the undo group.
    Cmd("ClearAll", MyNewUndo)
    Cmd("Fixture 1", MyNewUndo)
    Cmd("Fixture 2", MyNewUndo)
    Cmd("Fixture 5", MyNewUndo)
    Cmd("Fixture 7", MyNewUndo)
    local closeSuccess = CloseUndo(MyNewUndo)     -- Closing the undo group and store it's return in a variable.

    Printf(closeSuccess)    -- Print the feedback from the closing action - 1 = Success / 0 = Failure.
end

return main