waitln

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

waitln 機能

[通信コマンド]

文字列を含む行を待ちます。

コマンドライン

waitln <string1> [<string2> ...]

機能説明

文字列 <string1> [<string2> ...] のうち一つを含む行をホストから受信するか、タイムアウトが発生するまでマクロを停止します。
文字列は最大 10 個まで指定できます。

空文字列が指定された場合、任意の一文字(+改行)を受信するのを待ちます。

システム変数 timeout か mtimeout が 0 より大きい場合、<timeout>.<mtimeout> 秒の時間がすぎるとタイムアウトが発生します。
タイムアウトの値が 0 以下の場合は、タイムアウトは発生しません。

これらのコマンドは受信した行をシステム変数 inputstr に格納し、以下戻り値の値をシステム変数 result に格納します。

なお、<mtimeout> の精度は 50 msec 程度です。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<string1>文字列待機したい文字列(1つ目)を指定します。
<string2>文字列待機したい文字列(2つ目)を指定します。
<string3>文字列待機したい文字列(3つ目)を指定します。
<string4>文字列待機したい文字列(4つ目)を指定します。
<string5>文字列待機したい文字列(5つ目)を指定します。
<string6>文字列待機したい文字列(6つ目)を指定します。
<string7>文字列待機したい文字列(7つ目)を指定します。
<string8>文字列待機したい文字列(8つ目)を指定します。
<string9>文字列待機したい文字列(9つ目)を指定します。
<string10>文字列待機したい文字列(10個目)を指定します。

対象バージョン

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

戻り値

戻り値として以下の変数が定義されます。
変数名意味
result0タイムアウト。どの文字列も来なかった。
1<string1> を含む行を受信した。
2<string2> を含む行を受信した。
3<string3> を含む行を受信した。
4<string4> を含む行を受信した。
5<string5> を含む行を受信した。
6<string6> を含む行を受信した。
7<string7> を含む行を受信した。
8<string8> を含む行を受信した。
9<string9> を含む行を受信した。
10<string10> を含む行を受信した。
inputstr文字列受信した文字列(行単位)

関連コマンド

setdebug
wait
waitregex

使用方法

使用例

・文字列を含む行を待つ場合
waitln 'cal'
messagebox inputstr "str"  ; echo aaa cal hoge fuga

サンプル

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

備考

特にありません。