GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Six — File Functions (continued)

RenameFile Function

Overview

The RenameFile function renames an existing file or folder.

Syntax/Parameters

Syntax

int = RenameFile ( string existing, string new );

Parameters

existing

A string containing a fully qualified path with an optional filename. This parameter supports UTF encoding for filenames with Unicode characters.

new

A string containing a fully qualified path with an optional filename. This parameter supports UTF encoding for filenames with Unicode characters.

Return Value

Returns an int value as ERROR_NONE on success or a formatted error code on failure. Use the GetLastError function to retrieve error information. The GetLastErrorMessage function may contain information to supplement the error code. Error codes match Windows system error codes (for a list, see Appendix A — Legato SDK Standard Definitions or MSDN).

Remarks

The RenameFile function renames the file or directory specified by the existing parameter to the name given by the new parameter. The existing parameter must contain the path of an existing file or directory. The new parameter must not contain the name of an existing file or directory. The RenameFile function can be used to move a file from one directory or device to another by giving a different path in the new parameter. However, folders cannot be moved this way. Directories can only be renamed with this function. In addition, the RenameFile function cannot move a file to a different volume if that volume is a file cloud.

Related Functions

CanAccessFile — Tests for ability to access or create file using an optionally specified mode.

CreateFile — Creates a basic file with optional access mode and characteristics.

DeleteFile — Deletes the specified file (with open handle or closed with a string specification).

IsFile — Tests a string for being a valid path and filename.

OpenFile — Opens the specified file as a Basic File Object.

RecycleFile — Sends a file, folder or folder tree to the recycle bin or deletes it, if required.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.