Export(handle, file_path, file_name)

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

Version 2.0

説明

Export 関数は、オブジェクトをXMLファイルにエクスポートします。

引数

handle:
light_userdata 型のハンドルです。オブジェクトでコロン記法を用いる場合は省略できます(後述の例を参照)。
file_path:
ファイルのパスを表す文字列です。
file_name:
エクスポートされるファイル名を表す文字列です。

戻り値

この関数は何も返しません。オブジェクトをエクスポートします。

例

以下の2つの例は、どちらも選択したシーケンスをXMLファイルにエクスポートします。

コロン記法による例です。

Copy Code

Lua

return function()
    --SelectedSequence() creates a handle to the selected sequence.
    local selectedSequence = SelectedSequence()
    --The path is stored in a variable.
    local exportPath = GetPath(Enums.PathType.UserSequences)
    --The actual export function.
    selectedSequence:Export(exportPath, "mySelectedSequence.xml")
    --Print some feedback.                             
    Printf("The sequence is exported to: " .. exportPath)
end

引数にハンドルを指定しても同じ結果になります。

Copy Code

Lua

return function()
    --SelectedSequence() creates a handle to the selected sequence.
    local selectedSequence = SelectedSequence()
    --The path is stored in a variable.
    local exportPath = GetPath(Enums.PathType.UserSequences)
    --The actual export function.
    selectedSequence.Export(selectedSequence, exportPath, "mySelectedSequence2.xml")
    --Print some feedback.
    Printf("The sequence is exported to: " .. exportPath)
end