Back to product page

SftpRemoveDir method


Called when SFTP user wants to remove directory.

Type

None

Syntax

  • Basic
object.SftpRemoveDir Owner, User, RelativePath, ResolvedPath, Action
The SftpRemoveDir(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 remove a folder.
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 delete some directory on your system. You may deny this action by setting Action = Deny. Even is Action is set to Allow, user may receive an error if directory is not empty.

Platforms

Windows