Rename Method (FTP)

10.2, PLBCMP GUI Only

The Rename method changes a file or directory name that is located on the FTP server. This method uses the following format:

[label]	{object}.Rename	[GIVING {return}] USING [OldName=]{oldname*}:
		[NewName=]{newname*}

Where:

label

object

Required. A FTP that has been declared.

return

Optional. A Numeric Variable that returns the pass or fail value for the operation of this method.

oldname

Required. A Character String Variable or string liternal that specifies the local file name to be sent to the FTP server.

newname

Required. A Character String Variable that specifies the remote file name receiving the data on the system where the FTP server is executing.

Flags Affected: OVER, ZERO

Note the following:

The ZERO flag is set if the {return} value is zero which indicates that the method executed successfully.
The OVER flag is set if the {return} variable is too small to receive the pass/fail value without being truncated.
Debug log entries are generated if the debug logging is enabled. See the FTP Debug Method description to enable debug logging.
If this method fails, the {return} variable contains a value of two (2).

See Also: FTP Control Methods, Method Syntax