FilterStart Event

Fires once the filter has attached and filtering has started.

Syntax

public class DefaultCbfilterEventListener implements CbfilterEventListener {
  ...
  public void filterStart(CbfilterFilterStartEvent e) {}
  ...
}

public class CbfilterFilterStartEvent {
  public int resultCode;
}

Remarks

This event fires once the filter has attached and filtering has started; please refer to the StartFilter 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.