FilterStop Event

Fires once filtering has stopped and the filter has detached.

Syntax

// CBMonitorFilterStopEventArgs carries the CBMonitor FilterStop event's parameters.
type CBMonitorFilterStopEventArgs struct {...}

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

// CBMonitorFilterStopEvent defines the signature of the CBMonitor FilterStop event's handler function.
type CBMonitorFilterStopEvent func(sender *CBMonitor, args *CBMonitorFilterStopEventArgs)

func (obj *CBMonitor) GetOnFilterStopHandler() CBMonitorFilterStopEvent
func (obj *CBMonitor) SetOnFilterStopHandler(handlerFunc CBMonitorFilterStopEvent)

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.