Availability
This routine is available starting with katl-commons 4.0.7.
Syntax
fileMove(path_to_source, path_to_destination)
Description
Move a file from one location to another. Returns true if the file was moved successfully, false otherwise. If false is returned check the log for a detailed reason on why it failed.Parameters
Parameter name | Type | Required | Description |
---|---|---|---|
path_to_source | string | Yes | Specifies the source file name. |
path_to_destination | string | Yes | Specifies the destination file name. |
Return type
boolean (true/false)
Example
fileMove("C:/source.txt", "C:/destination");
If the source.txt file was moved to the folder destination, return 'true'.
Notes
It is recommended that you use forward slashes ( / ) for file paths.
See also