on_download_file Event
An override for a file download initiation operation.
Syntax
class FTPServerDownloadFileEventParams(object): @property def connection_id() -> int: ... @property def path() -> str: ... @property def restart_at() -> int: ... @property def operation_status() -> int: ... @operation_status.setter def operation_status(value) -> None: ... # In class FTPServer: @property def on_download_file() -> Callable[[FTPServerDownloadFileEventParams], None]: ... @on_download_file.setter def on_download_file(event_hook: Callable[[FTPServerDownloadFileEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application perform an overridden file download initiation operation.
This event only fires if Action = fraCustom was passed back from on_before_download_file event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.
Use the OperationStatus parameter to return the operation result back to the server.
This event will be followed by a number of on_read_file calls, requesting the file data from your code, followed by a single on_transfer_completed call.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |