wodSSHServer ActiveX Control - SftpDownloadFile Method
      
 

Description

Called when SFTP user wants to download file.


Return Type

None  


Syntax

object.SftpDownloadFile Owner, User, RelativePath, ResolvedPath, Action



The SftpDownloadFile Method syntax has these parts:

Part Description
object An expression evaluating to an object of type wodSSHD-Notifications.
Owner A wodSSHDCom object. Instance of wodSSHServer that called this notification method.
User A SSHUser object. Reference to user who wants to download a file.
RelativePath A String value. Relative path of the file, as seen by the user.
ResolvedPath A String value. Full path to the file on local system.
Action A 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.

Settings

The settings for Action are:

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

Remarks

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.