Skip to end of banner
Go to start of banner

fileMove

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Availability

This routine is available starting with katl-commons 4.0.7.

Syntax

fileMove(path_to_source, path_to_destination)

Description

Moves a file from one location to another.

Returns 'true' if the file was moved successfully and '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");

Returns 'true' if the source.txt file was moved to the folder destination.

Notes

It is recommended that you use forward slashes ( / ) for file paths.

See also

 

  • No labels