include

【Tera Term マクロ言語】コマンドリファレンス

include 機能

[制御コマンド]

インクルードファイルに移ります。

コマンドライン

include <include file name>

機能説明

引数に指定したマクロファイルを読み込み、マクロ実行を行います。
実行終了後、includeコマンドの次の行から処理が再開されます。
include のネスト (include したファイルの中で、さらに include) は 9 までです。

include 先へオプション(引数)やパラメータを渡すことはできません。
また、戻り値をうけとることもできません。
変数を利用して文字列や整数を受け渡す必要があります。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<include file name>文字列include したいファイルを指定します。

対象バージョン

全てのバージョンで利用可能です。

戻り値

戻り値はありません。

関連コマンド

exit

使用方法

使用例

・メインファイルから、インクルードファイルへ処理を移す場合

メインファイル
i=10
:loop
; インクルードファイルへ移る。
include 'sub.ttl'
if i>=0 goto loop
end
インクルードファイル 'sub.ttl'
if i<0 then
  messagebox 'error!' 'sub'
  ; メインファイルへ戻る。
  exit
endif
i = i - 1
; メインファイルへ戻る。
※ 上記指定方法の場合、メインファイルとインクルードファイルは、同じディレクトリに存在する必要があります。

サンプル

サンプルマクロはありません。

備考

通常、マクロファイルは、一括してメモリ上に読み込まれてから翻訳実行されます。
ただし、include した場合は、当該コマンドが実行される度に、指定されたマクロファイルを読み込みます。
ネットワーク上にあるマクロファイルを直接実行する際、ネットワークが切断されると、マクロコマンド include がエラーになります。

また、include したファイルにサブルーチンを記述することはできません。
(処理を移動できないことからエラーとなり、call することができません)