CorelScriptTools.Rename method - Developer Area

API Documentation > Corel DESIGNER > 2022-v24.2 > CorelScriptTools > ICorelScriptTools

CorelScriptTools.Rename method

Rename

Syntax:

Function Rename(ByVal Src As String, ByVal Dst As String, Optional ByVal Overwrite As Long = 1) As Boolean

Parameters:

Name	Type	Description
Src	String	Specifies the name of the file or folder to move. file_folder1 can include drive and folder path specifics; if path specifics are not included, Rename assumes the current folder.
Dst	String	String expression specifying the name of the file where file_folder1 is to be moved. file_folder2 can include drive and folder path specifics; if path specifics are not included, Rename assumes the current folder.
Overwrite	Long	If file_folder2 already exists, determines whether to overwrite the existing file (you cannot overwrite existing folders): 0 = rename and overwrite 1 = overwrite fails (default if omitted)

Remarks:

The Rename statement changes the name of a file or folder, or can be used to move a file. You cannot move a folder using the Rename statement.

You can also use Rename as a function: it returns True (-1) if the Rename operation is successful or False (0) if is not.

Examples:

The following VBA example moves the example1.vp file to the Work folder on the D drive.

' statement example
DIM x AS STRING
DIM y AS STRING
x = "C:\work\example1.vp"
y = "D:\work\example1.vp"
RENAME x, y, 0

The following VBA example renames the example1.cdr file to example2.cdr and assigns -1 to success.

' statement example
DIM x AS STRING
DIM y AS STRING
x = "C:\work\example1.cdr"
y = "C:\work\example2.cdr"
success = RENAME (x, y, 0)

Version Information:

CorelDRAW:	X7.4, X7, X7.6, X8, 2017, 2018, 2019, 2019.2, 2020, 2021, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3, 2023-v24.5, 2024-v25
Corel DESIGNER:	X7, 2017.1, 20.1, 2019.2, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3, 2023-v24.5, 2024-v25