変数
2021/05/18 05:49
変数
このページは Tera Term の変数について記載しています。変数名ルール
変数名には、以下の文字が利用できます。| 対象文字 | 制限 |
|---|---|
| [a-z] | なし |
| [A-Z] | なし |
| _（アンダースコア） | なし |
| -（ハイフン） | 2文字目以降のみ |
| [0-9] | 2文字目以降のみ |
また、Tera Term が利用する変数名やコマンド名等は予約語であり、利用できません。
例:
VARIABLE
var-1a
_flag
_01-Variable
予約語
Tera Term で定義されるコマンドや演算子、一部の変数名については、ユーザが変数やラベルの名前として定義して利用することができません。以下に、変数名として利用できない名前をリストします。
コマンド
exec や logopen 等のコマンド。コマンド一覧 を参照してください。
演算子
and, not, or, xorシステム変数
以下は Tera Term が予約しているシステム変数と、そのシステム変数を利用するコマンドの一覧です。バージョンによって、増減する可能性あります*1。
文字列型
文字列型のシステム変数は、以下 20 個が予約されています。| 数 | 名前 | 型 | 初期値 | システム変数を使用するコマンド |
|---|---|---|---|---|
| 1 | groupmatchstr1 | 文字列 | (Null) | 【S】 strjoin strmatch strreplace strsplit 【W】 waitregex |
| 2 | groupmatchstr2 | 文字列 | (Null) | |
| 3 | groupmatchstr3 | 文字列 | (Null) | |
| 4 | groupmatchstr4 | 文字列 | (Null) | |
| 5 | groupmatchstr5 | 文字列 | (Null) | |
| 6 | groupmatchstr6 | 文字列 | (Null) | |
| 7 | groupmatchstr7 | 文字列 | (Null) | |
| 8 | groupmatchstr8 | 文字列 | (Null) | |
| 9 | groupmatchstr9 | 文字列 | (Null) | |
| 数 | 名前 | 型 | 初期値 | システム変数を使用するコマンド |
| 10 | inputstr | 文字列 | (Null) | 【F】 filenamebox 【I】 inputbox 【P】 passwordbox 【R】 recvln 【S】 sprintf 【W】 waitln waitn waitrecv waitregex |
| 数 | 名前 | 型 | 初期値 | システム変数を使用するコマンド |
| 11 | matchstr | 文字列 | (Null) | waitregex strmatch |
| 数 | 名前 | 型 | 初期値 | システム変数を使用するコマンド |
| 12 | param1 | 文字列 | マクロ起動時のコマンドラインパラメータ。そのうち、マクロファイル名。 | |
| 13 | param2 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param1 の次のパラメータ。 | |
| 14 | param3 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param2 の次のパラメータ。 | |
| 15 | param4 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param3 の次のパラメータ。 | |
| 16 | param5 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param4 の次のパラメータ。 | |
| 17 | param6 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param5 の次のパラメータ。 | |
| 18 | param7 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param6 の次のパラメータ。 | |
| 19 | param8 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param7 の次のパラメータ。 | |
| 20 | param9 | 文字列 | マクロ起動時のコマンドラインパラメータのうち、param8 の次のパラメータ。 | |
| 数 | 名前 | 型 | 初期値 | システム変数を使用するコマンド |
文字列型配列
文字列型配列のシステム変数は、以下 1 個が予約されています。| 数 | 名前 | 型 | 初期値 | システム変数を使用するコマンド |
|---|---|---|---|---|
| 1 | params[x] | 文字列型配列 | (Null) | 基本的には param1 ～ param9 と同じ情報が params[1] ～ params[9] に入る。 10番以降（params[10]）も利用可能。 |
| 数 | 名前 | 型 | 初期値 | システム変数を使用するコマンド |
整数型
整数型のシステム変数は、以下 4 個が予約されています。真偽
基本方針
Tera Term マクロでは、基本的に以下の値を利用します。| 数値 | 真偽 | 成否 | 備考 |
|---|---|---|---|
| 0 | 偽 | 失敗した。 | |
| 0以外 | 真 | 成功した。 | 例えば connect は「1 = リンクのみ OK」「2 = リンクも接続も OK」というような利用方法をしています。 |
戻り値として 0 以外の整数が、基本的に "真" となっています。
例外
filecreate 等、一部のコマンドでは成否が変更することがあります。filecreate コマンドでの result の意味は、以下の通りです。
| 数値 | 意味 |
|---|---|
| -1 | ファイルの作成が失敗した |
| 0 | ファイルの作成が成功した |
| 数値 | 真偽 | 成否 | 備考 |
|---|---|---|---|
| 0 | 真 | 成功した。 | |
| 0以外 | 偽 | 失敗した。 |