FileMove() 関数FileMove()かんすう
- Last UpdatedSep 26, 2024
- 1 minute read
ソース ファイルを移動先ファイルに移動して、結果状態を返します。また、ファイルの名前を変更するときにも使用できます。この関数の実行には時間がかかることがあり、以下の複数の段階で実行されます。
-
FileMove() 関数が呼び出され、ファイル移動開始が成功または失敗したかを示す結果が返されます。
-
FileMove() 関数は、バックグランドで移動操作を実行し、InTouch スクリプトは、ファイルの移動中も実行を続けます。ファイル移動の進行状況は、整数型タグを使用して監視できます。
-
FileMove() 関数は、ファイル移動操作が成功または失敗したかを示す、ファイル移動の結果を返します。
FileMove() 関数は、非同期クイック関数では使用しないでください。
構文
result = FileMove (sourcefile, destfile, progresstag)
パラメータ
sourcefile
移動されるファイルのフル パスおよびファイル名です。リテラル文字列値、メッセージ型タグ名、または文字列式です。このパラメータでワイルカード文字（* および ?）を使用すると、指定条件に一致するファイルだけを移動できます。パス名には、UNC パス名も使用できます。
destfile
コピー先のフル パスおよびファイル名（またはパス名のみ）です。リテラル文字列値、メッセージ型タグ名、または文字列式です。パス名には、UNC パスも使用できます。
progresstag
ファイル移動の進行状況を示す値を含む、二重引用符で囲まれた整数型タグの名前です。リテラル文字列値、メッセージ型タグ名（値 "IntTag" を含むメッセージ型タグなど）、または文字列式です。値の意味は以下のとおりです。
0 - FileMove() 操作は現在進行中です。
1 - FileMove() 操作は正常に完了しました。
-1 - FileMove() 操作はエラーで終了しました。
戻り値
以下を示す -1、0、または 1 の値です。
1 - FileMove() 関数は、正常に呼び出されました。
0 - 別の FileMove() 操作がすでに実行されているため、FileMove() 関数を呼び出すときにエラーが発生しました。
-1 - FileMove() 関数を呼び出すときにエラーが発生しました。存在しないファイルを移動しようとしたなどのエラーが考えられます。
例
このスクリプトは、ファイル c:\MyData\output.log をディレクトリ d:\archive に移動して、ファイルの名前を output.txt に変更します。ファイル移動の進行状況は、整数型タグ Monitor に書き込まれます。
Status=FileMove("c:\MyData\output.log","d:\archive\output.txt","Monitor");
このスクリプトは、c:\ ルート ディレクトリにあり名前が .txt で終わるすべてのファイルを移動先ディレクトリ c:\Backup に移動します。
Status=FileMove("c:\*.txt", "c:\Backup", "Monitor");
このスクリプトは、フル パスおよびファイル名がメッセージ型タグ LogFile に含まれるファイルを移動先ディレクトリ c:\results\ に移動して、そのファイルの名前を logxxx.txt に変更します。ここで、xxx はタイムスタンプです。
Status=FileMove(LogFile, "c:\results\log" + $DateString + $TimeString + ".txt", "Monitor");