Back to product page

ListDir notification


Called when user lists directory.

Syntax

  • Basic
object.ListDir Owner, User, RelativePath, ResolvedPath, Action
The ListDir(object,Owner,User,RelativePath,ResolvedPath,Action) syntax has these parts:
objectAn expression evaluating to an object of type wodFTPDNotify.
OwnerA wodFTPDCom object. Reference to wodFTPServer instance that called this notification method.
UserA FtpUser object. Reference to user who is listing directory contents.
RelativePathA String value. Path to the directory, as seen by the user.
ResolvedPathA String value. Full path to the folder on local system.
ActionA FtpActions enumeration, as described in settings. When set to Deny/SilentDeny, wodFTPServer denies this action.

Remarks

NOTE: This method is called only if you implemented IwodFTPDNotify interface in your application, and wodFTPD.Notification property has received reference to instance of your implementation.

This notification method is called when user sends command to list contents of a directory. Usually in FTP protocol this is LIST and NLST commands, and in SFTP protocol this is special formed packet request.

If you want to hide directory contents, just set Action = Deny and the client will receive an error (permission denied error).

If you want to 'resolve' requested RelativePath to some different location - just set ResolvedPath argument to something else. This is great for creating 'virtual directories' which point to something completely different on your system. Client will never know for this change - all he knows is he's getting directory list for RelativePath.

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