changequote({,})
define({_TITLE_},{Varkon MBS Programmers manual})
define({_SUBTITLE_},{- test_file - Function})
define({_INDEXLINK_},{<a href="fileindx.htm">index</a>})
define({_STYLE_},{../varkonstyle.css})
include(../../include/header.inc)


<h1>test_file - Function</h1>

<h2>Description</h2>

<p>
Checks the existence and permissions of a named file.
</p>

<h2>Syntax</h2>

<pre>
  status:=test_file(name, mode);

  int status;
  string name;
  string mode;
</pre>

<h2>Principal parameters</h2>

<table>
<tr>
<td>name</td>
<td>- Name (including optional path) of file to test</td>
</tr>

<tr>
<td>mode</td>
<td>- What to test</td>
</tr>

<tr>
<td></td>
<td>&nbsp;&nbsp; &quot;X&quot; = Does the file exist ?</td>
</tr>

<tr>
<td></td>
<td>&nbsp;&nbsp; &quot;R&quot; = Do I have permission to open the file for reading ?</td>
</tr>

<tr>
<td></td>
<td>&nbsp;&nbsp; &quot;W&quot; = Do I have permission to open the file for writing ?</td>
</tr>
</table>

<h2>Optional parameters</h2>

<p>None.</p>

<h2>Return value</h2>

<p>
An INT value = 1 if the answer is yes or = 0 if the answer is no.
</p>

<h2>Comments</h2>

<p>
Mode codes may be upper or lower case.
</p>

<p>
Write permission is needed to delete or rename a file.
</p>

<h2>See also</h2>

<p><a href="iostat.htm">iostat()</a></p>

include(../../include/svnversion.inc)
include(../../include/footer.inc)