Back to product page

SftpDownloadFile method

Called when SFTP user wants to download file.




  • Basic
object.SftpDownloadFile Owner, User, RelativePath, ResolvedPath, Action  
The SftpDownloadFile(object,Owner,User,RelativePath,ResolvedPath,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 download a 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 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 before used starts downloading file pointed by RelativePath variable. You can disable file download by specifying Action = Deny. This notification method can also be called if ServiceType was stSCP - when client performs SCP download.