CBFS Filter 2020 Python Edition

Questions / Feedback?

on_filter_start Event

Fires once the filter has attached and filtering has started.

Syntax

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

# In class CBMonitor:
@property
def on_filter_start() -> Callable[[CBMonitorFilterStartEventParams], None]: ...
@on_filter_start.setter
def on_filter_start(event_hook: Callable[[CBMonitorFilterStartEventParams], None]) -> None: ...

Remarks

This event fires once the filter has attached and filtering has started; please refer to the start_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 (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. 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.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Python Edition - Version 20.0 [Build 8317]