FilterStop Event

Fires once filtering has stopped and the filter has detached.

Syntax

// CBFilterFilterStopEventArgs carries the CBFilter FilterStop event's parameters.
type CBFilterFilterStopEventArgs struct {...}

func (args *CBFilterFilterStopEventArgs) ResultCode() int32
func (args *CBFilterFilterStopEventArgs) SetResultCode(value int32)

// CBFilterFilterStopEvent defines the signature of the CBFilter FilterStop event's handler function.
type CBFilterFilterStopEvent func(sender *CBFilter, args *CBFilterFilterStopEventArgs)

func (obj *CBFilter) GetOnFilterStopHandler() CBFilterFilterStopEvent
func (obj *CBFilter) SetOnFilterStopHandler(handlerFunc CBFilterFilterStopEvent)

Remarks

This event fires once filtering has stopped and the filter has detached; please refer to the StopFilter 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.