Back to product page

SftpDownloadFile event

Fires when SFTP user wants to download file.


  • Basic
Private Sub object_SftpDownloadFile(User, RelativePath, ResolvedPath, Action)
The SftpDownloadFile(object,User,RelativePath,ResolvedPath,Action) syntax has these parts:
objectA wodSSHD object.
UserA SSHUser object. Reference to user who wants to download file.
RelativePathA String value. Relative path of the file, as seen by the user.
ResolvedPathA String value. Full path to the file on local system.
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 event is fired before used starts downloading file pointed by RelativePath variable. You can disable file download by specifying Action = Deny.

This event can also fire if ServiceType was stSCP - when client performs SCP download.