Back to product page

SftpDeleteFile method


Called when SFTP user wants to delete file.

Type

None

Syntax

  • Basic
object.SftpDeleteFile Owner, User, RelativePath, ResolvedPath, Action  
The SftpDeleteFile(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 delete 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.

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 tries to delete some file on your system. You can set Action = Deny if you do not wish this action to be performed, and error will be generated and sent to the user.

Platforms

Windows