on_close_file Event

This event instructs the application to close an opened file.

Syntax

class SFTPServerCloseFileEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def handle() -> str: ...
  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class SFTPServer:
@property
def on_close_file() -> Callable[[SFTPServerCloseFileEventParams], None]: ...
@on_close_file.setter
def on_close_file(event_hook: Callable[[SFTPServerCloseFileEventParams], None]) -> None: ...

Remarks

This event is fired upon receipt of a close-file packet from a client. Servers implementing virtualized transfers must close the previously opened local file referenced by Handle in this event handler. No further operations are allowed with the closed file.

Set OperationStatus to one of the following values to report the result of this operation to the client: