macro/command/filelock.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>filelock</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="stylesheet" href="../../style.css" type="text/css">
</head>

<body>


<h1>filelock</h1>

<p>
Locks the specified file. <em>(version 4.74 or later)</em>
</p>

<pre class="macro-syntax">
filelock &lt;file handle&gt; [&lt;timeout&gt;]
</pre>

<h2>Remarks</h2>

<p>
Locks the specified whole file for exclusive access by the calling process. <br>
The &lt;timeout&gt; argument is described below.
</p>

<table>
 <tr>
  <th><b>&lt;timeout&gt;</b></th>
  <td><b>Description</b></td>
 </tr>
 <tr>
  <th>0</th>
  <td>Returns quickly the error when the file is already locked.</td>
 </tr>
 <tr>
  <th>Abbreviation</th>
  <td>Returns only when the file is unlocked.</td>
 </tr>
 <tr>
  <th>Value</th>
  <td>Waits until the file is unlocked or the time-out interval(in seconds) elapses. 
      Returns the error when the time-out interval elapsed.</td>
 </tr>
</table>

<p>
If the function succeeds, the system variable "result" is set to 0.<br>
If the function fails, the system variable "result" is set to 1.
</p>


<h2>Examples</h2>

<pre class="macro-example">
fileopen fhandle 'test.txt' 0
filelock fhandle
if result!=0 then
        messagebox 'error' 'hoge'
endif
filewrite fhandle 'sample'
pause 60
fileunlock fhandle
if result!=0 then
        messagebox 'error' 'hoge'
endif
fileclose fhandle
</pre>

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

</body>
</html>