loginfo

2024/09/01 15:33 Macro::TTL コマンドリファレンス
【Tera Term マクロ言語】コマンドリファレンス

loginfo 機能

[通信コマンド]
Tera Term のログ取得状態を得ます。

コマンドライン

loginfo <strvar>

機能説明

Tera Term のログ取得状態を得ます。
<strvar>
ログ取得中であれば、指定した変数に取得中のログファイル名が格納されます。

ログを取得している場合、<strvar> にログファイル名が格納され、ログ取得時のフラグの状態が <result> に格納されます。
ログを取得していない場合は <result> に -1 が格納されます。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータ型パラメータ説明
<strvar>文字列変数名を指定します。

対象バージョン

バージョン 4.73 以降で利用可能です。

戻り値

戻り値として以下の変数が定義されます。
変数名値意味
result-1ログを取得していない
0～31ログ取得時のフラグの状態。詳細は、以下 <rusult> の値に対する状態を参照
<strvar>文字列ログ取得中のファイル名
<strvar> は、コマンド実行時に指定した任意の文字列です。

ログ取得時に <rusult> に格納される値は、以下の内 on になっているフラグに対応する値の合計となります。
値意味
1バイナリフラグ
2アペンドフラグ
4プレインテキストフラグ
8タイムスタンプフラグ
16ダイアログ非表示フラグ
バイナリフラグとアペンドフラグが有効ならば、<rusult> の値は 3 です。

実際に result の値に対してどのフラグが有効になるのか表にしました。
値バイナリアペンドプレインテキストタイムスタンプダイアログ非表示
-1ログを取得していない
値バイナリアペンドプレインテキストタイムスタンプダイアログ非表示
0ーーーーー
1〇ーーーー
値バイナリアペンドプレインテキストタイムスタンプダイアログ非表示
2ー〇ーーー
3〇〇ーーー
値バイナリアペンドプレインテキストタイムスタンプダイアログ非表示
4ーー〇ーー
5〇ー〇ーー
6ー〇〇ーー
7〇〇〇ーー
値バイナリアペンドプレインテキストタイムスタンプダイアログ非表示
8ーーー〇ー
9〇ーー〇ー
10ー〇ー〇ー
11〇〇ー〇ー
12ーー〇〇ー
13〇ー〇〇ー
14ー〇〇〇ー
15〇〇〇〇ー
値バイナリアペンドプレインテキストタイムスタンプダイアログ非表示
16ーーーー〇
17〇ーーー〇
18ー〇ーー〇
19〇〇ーー〇
20ーー〇ー〇
21〇ー〇ー〇
22ー〇〇ー〇
23〇〇〇ー〇
24ーーー〇〇
25〇ーー〇〇
26ー〇ー〇〇
27〇〇ー〇〇
28ーー〇〇〇
29〇ー〇〇〇
30ー〇〇〇〇
31〇〇〇〇〇
値バイナリアペンドプレインテキストタイムスタンプダイアログ非表示
※ 〇 は有効で、ー は無効であることを意味します。

関連コマンド

種別：通信Ver機能の簡易説明
logautoclosemode4.79以降マクロ終了時、自動的にログ採取を停止する。
logcloseTera Term のログを終了する。
logopenTera Term のログを開始する。
4.61以降ログ再生可能なバイナリオプションの追加。
4.62以降ログを開けたかどうか result を返す仕様の追加。
4.80以降端末バッファをログへ含めるオプションの追加。
4.97以降ログ行頭へタイムスタンプを追記するオプションの追加。
logpauseTera Term のログを一時中断する。
logrotate4.78以降ログをローテートする。
logstart中断していた Tera Term のログを再開する。
logwrite文字列をログに書き込む。>文字列をログに書き込む。

使用方法

使用例

loginfo logfile

if result == -1 then
	; ログを取得していないので、新たにログ取得を開始する
	logopen "test.log" 0 0 0 1

elseif result & 8 == 0 then
	flags = result
	; タイムスタンプが無効なので、タイムスタンプを有効にして開きなおす。
	logclose
	logopen logfile 0 1 flags&4 1 flags&16
endif

サンプル

ログを一度閉じて、開きなおしているサンプルです。

備考

特にありません。