$ItsOpen: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (misc formatting) |
||
| Line 1: | Line 1: | ||
<p>The $ | <p> | ||
The <var>$ItsOpen</var> function lets you determine whether a file is open. <var>$ItsOpen</var> only checks files, not groups of files. The return codes are:</p> | |||
<table> | <table> | ||
<tr> | <tr> | ||
<td>0</td> | <td>0</td> | ||
<td> | <td>The file is not open.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>1</td> | <td>1</td> | ||
<td> | <td>The file is open.</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
<p>The format for the $ | ==Syntax== | ||
<p class=" | <p> | ||
The format for the <var>$ItsOpen</var> function is:</p> | |||
<p class="syntax">$ItsOpen({[FILE] <span class="term">name</span> [AT <span class="term">location</span>] | [PERM | TEMP] [GROUP] <span class="term">name</span>}) | |||
</p> | </p> | ||
<p>where name (optional) is a %variable or a literal name of the file or group. You < | <p> | ||
where <var class="term">name</var> (optional) is a %variable or a literal name of the file or group. You <b>must</b> enter the filename in uppercase. A file synonym name can also be used. </p> | |||
<p class="code"> | <p> | ||
% | If you do not enter a location (specifying a null argument), <var class="product">Model 204</var> uses the reference context (at compile time) of the statement that calls the function.</p> | ||
% | |||
==Example== | |||
<p class="code">Begin | |||
%file Is String Len 8 | |||
%file = $read('ENTER THE FILENAME') | |||
If $itsopen(%file) Then | |||
Print %file ' IS OPEN' | |||
Else | |||
Print %file ' IS NOT OPEN' | |||
End | |||
</p> | </p> | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li>[[$Context]], which returns a number to indicate whether the context is a file or group. | <li><var>[[$Context]]</var>, which returns a number to indicate whether the context is a file or group. | ||
</ul> | </ul> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Revision as of 22:30, 14 July 2017
The $ItsOpen function lets you determine whether a file is open. $ItsOpen only checks files, not groups of files. The return codes are:
| 0 | The file is not open. |
| 1 | The file is open. |
Syntax
The format for the $ItsOpen function is:
$ItsOpen({[FILE] name [AT location] | [PERM | TEMP] [GROUP] name})
where name (optional) is a %variable or a literal name of the file or group. You must enter the filename in uppercase. A file synonym name can also be used.
If you do not enter a location (specifying a null argument), Model 204 uses the reference context (at compile time) of the statement that calls the function.
Example
Begin %file Is String Len 8 %file = $read('ENTER THE FILENAME') If $itsopen(%file) Then Print %file ' IS OPEN' Else Print %file ' IS NOT OPEN' End
See also
- $Context, which returns a number to indicate whether the context is a file or group.