Full path: /system/filesystem/copy
Copies a file from a source to a target directory. Optionally, the file can be copied with a new name to the target directory. When invoked from a simple execution step, this function copies one file at a time. To copy multiple files with FlowForce, enclose the step which calls the copy function inside a For each step, as illustrated in the Copy Files example.
This function returns Boolean TRUE if execution was successful. If the job execution fails, the outcome depends on the value of the Abort on error parameter, as follows:
•If the Abort on error parameter is TRUE (default value), the job execution is aborted. In this case, you can still handle errors by means of protected blocks (see Handling Step Errors).
•If the Abort on error parameter is FALSE, the function returns FALSE.
Parameters
Name |
Type |
Description |
|---|---|---|
Source |
string as file |
The path and file name of the source file that you want to copy. |
Target |
string as file |
The path and file name of the destination directory. You can enter a different file name in the destination field if you want to rename it as well. |
Overwrite |
boolean |
When true, causes the destination file to be overwritten. The default value is false . |
Abort on error |
boolean |
This Boolean parameter determines what should be the return value of the function if the job fails. If Abort on error is FALSE, the function will return Boolean FALSE as well. If Abort on error is TRUE, the job execution is aborted. The default value is TRUE. |
Working directory |
string as directory |
Specifies the working directory (for example, c:\somedirectory). If relative paths are used, they will be resolved against the working directory. |
Examples
See Copy Files.
