RenameFile Method
Change the name of RemoteFile to NewName .
Syntax
ANSI (Cross Platform) int RenameFile(const char* lpszNewName); Unicode (Windows) INT RenameFile(LPCWSTR lpszNewName);
- (void)renameFile:(NSString*)newName;
#define MID_SFTP_RENAMEFILE 17 IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SFTP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
The name of remote file or folder specified by RemoteFile is changed to NewName. RemoteFile and NewName are either absolute paths on the server, or a path relative to RemotePath.
If there is no SSH session in place, one is automatically created by the component first.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)