Back to product page

SftpListDir method


Called when SFTP user lists directory.

Type

None

Syntax

  • Basic
object.SftpListDir Owner, User, RelativePath, ResolvedPath, Action  
The SftpListDir(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 list folder contents.
RelativePathA String value. Relative path of the folder, as seen by the user.
ResolvedPathA String value. Full path to the folder 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.

Remarks

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 wants to download contents of some directory. If you do not wish to give user access to the directory, you should set Action = Deny.

Platforms

Windows