on_filter_stop Event

Fires once filtering has stopped and the filter has detached.

Syntax

class CBFilterFilterStopEventParams(object):
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_filter_stop() -> Callable[[CBFilterFilterStopEventParams], None]: ...
@on_filter_stop.setter
def on_filter_stop(event_hook: Callable[[CBFilterFilterStopEventParams], None]) -> None: ...

Remarks

This event fires once filtering has stopped and the filter has detached; please refer to the stop_filter method for more information.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason, set it to a non-zero value to report an appropriate error. Note, however, that this event fires after the operation has already completed, so reporting an error won't actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.