Back to product page

Rename event


Fires when user wants to rename file or directory.

Syntax

  • Basic
Private Sub object_Rename(User, RelativePath, ResolvedPath, NewName, Action)
The Rename(object,User,RelativePath,ResolvedPath,NewName,Action) syntax has these parts:
objectAn expression evaluating to an object of type wodFTPD.
UserA FtpUser object. Reference to user who is renaming file/directory.
RelativePathA String value. Path to the file/directory, as seen by the user.
ResolvedPathA String value. Full path to the file/folder on local system.
NewNameA String value. New name for the file/directory.
ActionA FtpActions enumeration, as described in settings. When set to Deny/SilentDeny, wodFTPServer denies this action.

Remarks

Rename event is fired when user requests name change for some file or directory. You can allow this change, or deny it, by setting Action argument to Allow or Deny. Also, you can change ResolvedPath and NewName arguments to point to completely different file on your file system, not necessarily original one requested by the user.

The settings for Action are
Constant Value Description
Deny0 Deny execution of the action.
Allow 1 Allow to execute action.
SilentDeny2 Silently deny execution of the action.
SilentAllow 3 Silently allow to execute action.

Platforms

Windows