Back to product page
- Introduction
- Overview
- License agreement
- Getting Started
- Objects
- Enumerations
- wodFTPD
- Methods
- Properties
- Authentication
- BindIP
- BindIPType
- Certificate
- DirFormat
- Encryption
- EncryptionList
- FileLocking
- FIPS
- ForceUTF8
- GoodbyeMessage
- GreetingMessage
- HMacList
- HostKeyList
- KeyExchangeList
- MaxDataPort
- MinDataPort
- MonitorTransfers
- MyHostname
- MyIP
- Notification
- PasvPort
- Port
- Protocol
- Secure
- ServerName
- SFTPVersion
- Status
- StrictDataIP
- Threads
- Timeout
- UseIPv6
- Users
- Version
- VirtualFiles
- VirtualFolders
- Events
- wodFTPDNotify
- FtpUser
- FtpUsers
- VirtualFile
- VirtualFiles
- VirtualFolder
- VirtualFolders
- How to get support?
- Technical information
- Fast notifications interface
- Error list
DownloadFile notification
Called when user wants to download file.
Syntax
- Basic
object.DownloadFile Owner, User, RelativePath, ResolvedPath, Action
The DownloadFile (object,Owner,User,RelativePath,ResolvedPath,Action) syntax has these parts:
The DownloadFile (object,Owner,User,RelativePath,ResolvedPath,Action) syntax has these parts:
object | An expression evaluating to an object of type wodFTPDNotify. |
Owner | A wodFTPDCom object. Reference to wodFTPServer instance that called this notification method. |
User | A FtpUser object. Reference to use who wants to download file. |
RelativePath | A String value. Path to the file, as seen by the user. |
ResolvedPath | A String value. Full path to the file on local system. |
Action | A 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.DownloadFile notification method is called when connected users tries to download file. Inside this method body, you get relative path to filename as seen by the client. wodFTPServer internally (using HomeDir property) tries to resolve this file and provides ResolvedPath argument that points to actual file on disk that will be downloaded. At this point you can change ResolvedPath argument to something completely different - and cause client to download something else without seeing any difference.
If you set Action = Deny, then client will receive 'permission denied' error and will not be able to download the file.
The settings for Action are
Constant | Value | Description |
---|---|---|
Deny | 0 | Deny execution of the action. |
Allow | 1 | Allow to execute action. |
SilentDeny | 2 | Silently deny execution of the action. |
SilentAllow | 3 | Silently allow to execute action. |