4D Doc Center : FTP

Home

4D Internet Commands v14

FTP_Rename


FTP_Rename ( ftp_ID ; hostPath ; newName ) -> Function result

Parameter	Type	Description
ftp_ID	Longint	Reference to a FTP login
hostPath	Text	Pathname to document on FTP Server
newName	Text	New document name
Function result	Integer	Error Code

Description

Given a pathname to a file in the format of a hostPath, the FTP_Rename command will rename the specified file on the remote FTP Server. An error will be returned if you do not have sufficient access priveleges to perform this action.

ftp_ID is the long integer reference to the FTP session established with FTP_Login.

hostPath is the text path to the document to be renamed. The value of the hostPath parameter may be a full pathname specification or simple file name. If the shortened form is used then the specified file must be within the CWD.

newPathName contains the value you wish to rename the remote document.

Note: You can change the CWD using the FTP_ChangeDir command. You can also know the CWD at any time using the FTP_PrintDir command.