FileMove() 函数
- Last UpdatedSep 24, 2024
- 1 minute read
将源文件移到目标文件并返回状态结果。它也可以用于重命名文件。此函数可能要花费较长时间并分为多个阶段来执行:
-
调用 FileMove() 函数并返回中间结果,指出文件移动初始化操作是成功还是失败。
-
FileMove() 函数在后台执行移动过程,InTouch 脚本在文件移动的过程中继续执行。您可以使用整型标记来监视文件移动进度。
-
FileMove() 函数返回文件移动结果,指出文件移动过程是成功还是失败。
请勿在异步 QuickFunctions 中使用 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:\ root 目录中以 .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");