filelock

【Tera Term マクロ言語】コマンドリファレンス

filelock 機能

[ファイル操作コマンド]

開いているファイルをロックします。

コマンドライン

filelock <file handle> [<timeout>]

機能説明

すでに開いているファイルハンドル <file handle> を指定すると、ファイル全体をロックします。
ロック中、他のプロセスからの当該ファイルへのアクセスはエラーとなります。
[<timeout>]
引数 <timeout> については下記のとおりです。
<timeout>説明
省略ファイルがすでにロックされていたら、解除されるまで無限に待ちます。
0ファイルがすでにロックされていたら、即座にエラーを返します。
1 以上ファイルがすでにロックされていたら、解除されるまで指定した秒数を待ちます。
タイムアウトしたらエラーを返します。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<file handle>整数開いているファイルのファイルハンドル名を指定します。
<timeout>整数待機する秒数を指定します。

対象バージョン

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

戻り値

戻り値として以下の変数が定義されます。
変数名意味
result0ロックに成功した
1ロックに失敗した

関連コマンド

種別:ファイル操作Ver機能の簡易説明
fileunlock4.74以降開いているファイルのロックを解除する。

使用方法

使用例

・ファイルをロックする場合
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

サンプル

サンプルマクロはありません。

備考

特にありません。