DelVar(handle, string)

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

Version 2.2

説明

DelVar 関数は、変数セット内の特定の変数を削除します。プラグインにおける変数の詳細については、変数関数を参照してください。

引数

handle:
変数セットへのハンドルです。
string:
変数の名前です。引用符で囲む必要があります。

戻り値

boolean:
- true / 1: 変数が削除された。
- false / 0: 変数が削除されなかった。

変数が存在しない場合も false が返されます。

例

ユーザ変数セットから "myUserVar" という変数を削除します。

Copy Code

Lua

return function()
    -- Deletes the variable called 'myUserVar' in the 'UserVars' variable set.
    local success = DelVar(UserVars(), "myUserVar")
    -- Prints the outcome of the deletion outcome.
    if success then
        Printf("Variable is deleted.")
    else
        Printf("Variable is NOT deleted!")
    end
end