Back to product page

SftpRename method

Called when SFTP user wants to rename file or directory.




  • Basic
object.SftpRename Owner, User, RelativePath, ResolvedPath, NewName, Action  
The SftpRename(object,Owner,User,RelativePath,ResolvedPath,NewName,Action) syntax has these parts:
objectAn expression evaluating to an object of type IwodSSHDNotify.
OwnerA wodSSHDcom object. Instance of wodSSHServer that called this notification method.
UserA SSHUser object. Reference to user who wants to rename a file/folder.
RelativePathA String value. Relative path of the file/folder, as seen by the user.
ResolvedPathA String value. Full path to the file/folder on local system.
NewNameA String value. New name specified by the client.
ActionA SSHActions enumeration, as described in settings. You should set to Allow to allow this action, or to Deny if you don't want to allow it.


The settings for Action are:

Constant Value Description
Deny0 Deny execution of the action.
Allow 1 Allow to execute action.

This method is called only if you implemented IwodSSHNotify interface in your application, and wodSSHD.Notification property has received reference to instance of your implementation.

This notification method is called when user tries to rename some file on your system. You should decide whether you will allow the user to rename some file by using Action variable.