on_find_init Event

An override for a directory listing initiation operation.

Syntax

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

# In class FTPServer:
@property
def on_find_init() -> Callable[[FTPServerFindInitEventParams], None]: ...
@on_find_init.setter
def on_find_init(event_hook: Callable[[FTPServerFindInitEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application prepare for directory listing retrieval.

This event only fires if Action = fraCustom was passed back from on_before_find 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_find_next calls, requesting the directory listing entry by entry from your code, followed by a on_find_close call.

Set OperationStatus to one of the following values: