waitevent

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

waitevent 機能

[通信コマンド]

イベントを待ちます。

コマンドライン

waitevent <events>

機能説明

<events> で指定されるイベントが発生するまでマクロを停止します。
<events> は以下のイベント識別子の組み合わせです。

イベント識別子イベント内容
1timeoutシステム変数 timeout か mtimeout が 0 より大きい場合、<timeout>.<mtimeout> 秒の時間がすぎると(タイムアウト)イベントが発生します。
タイムアウトの値が 0 以下の場合は、タイムアウトは発生しません。
2unlinkunlink イベントは Tera Term が閉じられたときに発生します。
4disconnectiondisconnection (または connection) イベントは、Tera Term とホストの間の通信が閉じられた(開かれた)時に発生します。
8connection
これらのコマンドは実際に発生したイベントの識別子をシステム変数 <result> に格納します。

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

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<events>整数イベント識別子を指定します。

対象バージョン

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

戻り値

戻り値として以下の変数が定義されます。
変数名意味
result1timeout
2unlink
4disconnection
8connection

関連コマンド

関連コマンドはありません。

使用方法

使用例

・各種イベントを待つ場合
; disconnection イベントを待つ
waitevent 4
; unlink または connection イベントを待つ
waitevent 2 or 8
; unlink イベント発生
if result=2 goto label1
; connection イベント発生
if result=8 goto label2

サンプル

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

備考

特にありません。