macro/command/loginfo.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <title>loginfo</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="stylesheet" href="../../style.css" type="text/css">
</head>

<body>


<h1>loginfo</h1>

<p>
Retrieves Tera Term log status. <em>(version 4.73 or later)</em>
</p>

<pre class="macro-syntax">
loginfo &lt;strvar&gt;
</pre>

<h2>Remarks</h2>

<p>
When Tera Term is logging, the file name stores in the strvar variable and the flag status of log starting is stored in the system variable "result".<br>
On the contrary, when Tera Term is not logging, the system variable "result" is set to -1.
</p>
<p>
The system variable "result" is bitwise OR in the following value:
</p>

<table>
 <tr>
  <th>Value</th>
  <th>Meaning</th>
 </tr>
 <tr>
  <td>1</td>
  <td>Binary flag</td>
 </tr>
 <tr>
  <td>2</td>
  <td>Append flag</td>
 </tr>
 <tr>
  <td>4</td>
  <td>Plain text flag</td>
 </tr>
 <tr>
  <td>8</td>
  <td>Timestamp flag</td>
 </tr>
 <tr>
  <td>16</td>
  <td>Hide dialog flag</td>
 </tr>
</table>


<h2>Example</h2>

<pre class="macro-example">
loginfo logfile

if result == -1 then
        ; When Tera Term is not logging, a new log is started.
        logopen "test.log" 0 0 0 1

elseif result &amp; 8 == 0 then
        flags = result
        ; When the log timestamp is disabled, a new log with timestamp is re-opened.
        logclose
        logopen logfile 0 1 flags&amp;4 1 flags&amp;16
endif
</pre>


<h2>See also</h2>
<ul>
  <li><a href="logopen.html">logopen</a></li>
</ul>

</body>
</html>