on_rename_file Event
An override for a file rename operation.
Syntax
class FTPServerRenameFileEventParams(object): @property def connection_id() -> int: ... @property def old_path() -> str: ... @property def new_path() -> str: ... @property def operation_status() -> int: ... @operation_status.setter def operation_status(value) -> None: ... # In class FTPServer: @property def on_rename_file() -> Callable[[FTPServerRenameFileEventParams], None]: ... @on_rename_file.setter def on_rename_file(event_hook: Callable[[FTPServerRenameFileEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application perform an overridden file rename operation.
This event only fires if Action = fraCustom was passed back from on_before_rename_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 on_after_rename_file call which will let you make final adjustments to the returned code.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |