Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with SIL Engine™ 4.0.7.

Syntax

renameFile(path_to_source, path_to_destination)

Description

Renames a file.

Returns "true" if the file was renamed 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 new file name for the source file.

Return type

boolean (true/false)

Example

renameFile("C:/source.txt", "C:/destination.txt");

It returns 'true' if the source.txt file was renamed to destination.txt.

Notes

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

See also